diff --git a/components/parameter-table/ParameterRow.tsx b/components/parameter-table/ParameterRow.tsx index ed13fdfb6cd9..1545f2e4b773 100644 --- a/components/parameter-table/ParameterRow.tsx +++ b/components/parameter-table/ParameterRow.tsx @@ -136,7 +136,8 @@ export function ParameterRow({ nested parameters so we show a stub
element that triggers an API request to get the nested parameter data. */} - {(rowParams.type === 'object' || rowParams.type.includes('array of')) && + {rowParams.type && + (rowParams.type === 'object' || rowParams.type.includes('array of')) && rowParams.childParamsGroups && rowParams.childParamsGroups.length === 0 && !NO_CHILD_WEBHOOK_PROPERTIES.includes(rowParams.name) && ( diff --git a/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index 5b582d063045..e4f70c36cb33 100644 --- a/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -33,15 +33,13 @@ During initialization, the enterprise owner will name your enterprise, configure To begin initialization, you will receive an invitation email from {% data variables.product.company_short %}. Before you configure {% data variables.product.prodname_ghe_managed %}, review the following prerequisites. -1. To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." +To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." - {% note %} - - **Note**: {% data reusables.saml.create-a-machine-user %} +{% note %} - {% endnote %} +**Note**: {% data reusables.saml.create-a-machine-user %} -2. {% data reusables.saml.assert-the-administrator-attribute %} +{% endnote %} ## Signing in and naming your enterprise @@ -66,6 +64,7 @@ To configure authentication for {% data variables.product.product_name %}, you m !["Test SAML configuration" button](/assets/images/enterprise/configuration/ae-test-saml-configuration.png) 1. Click **Save**. !["Save" button for IdP configuration](/assets/images/enterprise/configuration/ae-save.png) +1. {% data reusables.saml.assert-the-administrator-attribute %} ## Setting your enterprise policies diff --git a/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md b/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md index 40b4a4a136b0..2fba529c0013 100644 --- a/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md +++ b/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md @@ -50,7 +50,7 @@ Clustering allows services that make up {% data variables.product.prodname_ghe_s - Establish tiers of nodes that make sense for your organization. An example configuration: - Front-end tier with two nodes and the following services: - `web-server` - - `jobs-server` + - `job-server` - `memcache-server` - Database tier with three nodes and the following services: - `consul-server` diff --git a/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md b/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md index 414cd71df64e..d9f9b98dbcbf 100644 --- a/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md @@ -41,10 +41,12 @@ To check the status of a running cluster use the `ghe-cluster-status` command. The cluster configuration file (`cluster.conf`) defines the nodes in the cluster, and what services they run. For more information, see "[About cluster nodes](/enterprise/admin/guides/clustering/about-cluster-nodes)." -This example `cluster.conf` defines a cluster with five nodes. +This example `cluster.conf` defines a cluster with 11 nodes. - - Two nodes (called `ghe-app-node-\*`) run the `web-server` and `job-server` services responsible for responding to client requests. - - Three nodes (called `ghe-data-node-\*`) run the services responsible for storage and retrieval of {% data variables.product.prodname_ghe_server %} data. + - Two nodes called `ghes-front-end-node-\*` run services responsible for responding to client requests. + - Three nodes called `ghes-database-node-\*` run services responsible for storage, retrieval, and replication of database data. + - Three nodes called `ghes-search-node-\*` run services responsible for search functionality. + - Three nodes called `ghes-storage-node-\*` run services responsible for storage, retrieval, and replication of data. The names of the nodes can be any valid hostname you choose. The names are set as the hostname of each node, and will also be added to `/etc/hosts` on each node, so that the nodes are locally resolvable to each other. @@ -52,63 +54,105 @@ Specify the first cluster node you configured as the MySQL primary via `mysql-se ```ini [cluster] - mysql-master = ghe-data-node-1 - redis-master = ghe-data-node-1 - primary-datacenter = default -[cluster "ghe-app-node-1"] - hostname = ghe-app-node-1 + mysql-master = ghes-database-node-1 + redis-master = ghes-database-node-1 + primary-datacenter = primary +[cluster "ghes-front-end-node-1"] + hostname = ghes-front-end-node-1 ipv4 = 192.168.0.2 # ipv6 = fd12:3456:789a:1::2 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-app-node-2"] - hostname = ghe-app-node-2 + memcache-server = true +[cluster "ghes-front-end-node-2"] + hostname = ghes-front-end-node-2 ipv4 = 192.168.0.3 # ipv6 = fd12:3456:789a:1::3 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-data-node-1"] - hostname = ghe-data-node-1 + memcache-server = true +[cluster "ghes-database-node-1"] + hostname = ghes-database-node-1 ipv4 = 192.168.0.4 # ipv6 = fd12:3456:789a:1::4 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-2"] - hostname = ghe-data-node-2 +[cluster "ghes-database-node-2"] + hostname = ghes-database-node-2 ipv4 = 192.168.0.5 # ipv6 = fd12:3456:789a:1::5 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-3"] - hostname = ghe-data-node-3 +[cluster "ghes-database-node-3"] + hostname = ghes-database-node-3 ipv4 = 192.168.0.6 # ipv6 = fd12:3456:789a:1::6 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true +[cluster "ghes-search-node-1"] + hostname = ghes-search-node-1 + ipv4 = 192.168.0.7 + # ipv6 = fd12:3456:789a:1::7 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-2"] + hostname = ghes-search-node-2 + ipv4 = 192.168.0.8 + # ipv6 = fd12:3456:789a:1::8 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-3"] + hostname = ghes-search-node-3 + ipv4 = 192.168.0.9 + # ipv6 = fd12:3456:789a:1::9 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-storage-node-1"] + hostname = ghes-storage-node-1 + ipv4 = 192.168.0.10 + # ipv6 = fd12:3456:789a:1::10 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true metrics-server = true +[cluster "ghes-storage-node-2"] + hostname = ghes-storage-node-2 + ipv4 = 192.168.0.11 + # ipv6 = fd12:3456:789a:1::11 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true storage-server = true + metrics-server = true +[cluster "ghes-storage-node-3"] + hostname = ghes-storage-node-3 + ipv4 = 192.168.0.12 + # ipv6 = fd12:3456:789a:1::12 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true + metrics-server = true ``` Create the file `/data/user/common/cluster.conf` on the configured first node. For example, using `vim`: diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 89dd8d1fe547..ceebd276ec9b 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -44,8 +44,6 @@ For more information about managing identity and access for your enterprise on { - {% data reusables.saml.ghes-you-must-configure-saml-sso %} {%- endif %} -- {% data reusables.saml.assert-the-administrator-attribute %} For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs. - - {% data reusables.saml.create-a-machine-user %} ## Configuring authentication and user provisioning with Azure AD @@ -77,3 +75,7 @@ In your Azure AD tenant, add the application for {% data variables.product.produ 1. After you ensure a successful connection, at the top of the page, click **Save**. {% endif %} + +1. Assign an enterprise owner for {% data variables.product.product_name %} in Azure AD. The process you should follow depends on whether you configured provisioning. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." + - If you configured provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, assign the enterprise owner role to the user in Azure AD. + - If you did not configure provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs. diff --git a/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md b/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md index 0e56df084315..692b4c28a681 100644 --- a/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md @@ -20,7 +20,13 @@ shortTitle: GPG verification After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_github_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." -Once you enable GPG verification, it will immediately take effect for all your codespaces. +{% data reusables.codespaces.gpg-in-active-codespaces %} + +{% note %} + +**Note:** If you have linked a dotfiles repository with {% data variables.product.prodname_github_codespaces %}, the Git configuration in your dotfiles may conflict with the configuration that {% data variables.product.prodname_github_codespaces %} requires to sign commits. For more information, see "[Troubleshooting GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces)." + +{% endnote %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} @@ -30,8 +36,4 @@ Once you enable GPG verification, it will immediately take effect for all your c !["Selected repositories" dropdown menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) -{% note %} - -**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, you also must append `-S` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings. - -{% endnote %} +Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, all commits are signed by default in your codespaces. \ No newline at end of file diff --git a/content/codespaces/troubleshooting/index.md b/content/codespaces/troubleshooting/index.md index 2aeca351ebd3..cabc8b2247c8 100644 --- a/content/codespaces/troubleshooting/index.md +++ b/content/codespaces/troubleshooting/index.md @@ -19,6 +19,7 @@ children: - /troubleshooting-dotfiles-for-codespaces - /troubleshooting-port-forwarding-for-github-codespaces - /troubleshooting-github-codespaces-clients + - /troubleshooting-gpg-verification-for-github-codespaces - /working-with-support-for-github-codespaces --- diff --git a/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md new file mode 100644 index 000000000000..0996c5ed4d0f --- /dev/null +++ b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md @@ -0,0 +1,112 @@ +--- +title: Troubleshooting GPG verification for GitHub Codespaces +shortTitle: GPG verification +intro: This article provides troubleshooting advice for errors related to signing your commits in codespaces. +versions: + fpt: '*' + ghec: '*' +type: reference +topics: + - Codespaces +--- + +If you enable GPG verification, {% data variables.product.prodname_github_codespaces %} automatically signs your commits in codespaces that you create from selected repositories. For more information, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)." + +{% data reusables.codespaces.gpg-in-active-codespaces %} + +If {% data variables.product.prodname_github_codespaces %} fails to sign a commit, you may see an error like the following. + +```Shell +$ git commit -m 'Initial commit' +error: gpg failed to sign the data +fatal: failed to write commit object +``` + +You may encounter this error if: + +- You have disabled GPG verification, and are trying to make a regular, unsigned commit in an existing codespace. +- You have enabled GPG verification, but have overridden the Git configuration required for {% data variables.product.prodname_github_codespaces %} to sign your commits, for example by linking {% data variables.product.prodname_github_codespaces %} with a dotfiles repository that contains Git configuration files. + +## Errors after disabling GPG verification + +When you enable GPG verification, {% data variables.product.prodname_github_codespaces %} signs all the commits you make in codespaces by default. It does this by setting the `commit.gpgsign` Git configuration value to `true`. + +If you have disabled GPG verification, and are working in an existing codespace, then this value will still be set to `true`. This means that {% data variables.product.prodname_github_codespaces %} will try to sign your commits, but will be unable to do so, because you have disabled the GPG verification setting. + +To keep making regular, unsigned commits in your codespace, reset `commit.gpgsign` to the default value of `false` by entering the following command in the terminal. + +```Shell{:copy} +git config --unset commit.gpgsign +``` + +To check that the value has been correctly removed from your configuration, you can enter `git config --list`. You should not see a value for `commit.gpgsign` in the list. + +## Errors caused by conflicting configuration + +To automatically sign your commits, {% data variables.product.prodname_github_codespaces %} sets certain Git configuration values in your codespace. If you override the values set by {% data variables.product.prodname_github_codespaces %}, you may be unable to sign your commits. + +You may be inadvertently overriding these values if you have linked {% data variables.product.prodname_github_codespaces %} with a dotfiles repository that contains Git configuration files. For more information about using dotfiles with {% data variables.product.prodname_github_codespaces %}, see "[Personalizing {% data variables.product.prodname_github_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." + +### Checking for conflicting configuration + +To sign your commits with GPG, {% data variables.product.prodname_github_codespaces %} automatically sets the following Git configuration values at the system level. + +| Configuration setting | Required value | +| --------------------- | -------------- | +| `user.name` | Must match the full name set on your {% data variables.product.prodname_dotcom %} profile | +| `credential.helper` | Must be set to `/.codespaces/bin/gitcredential_github.sh` | +| `gpg.program` | Must be set to `/.codespaces/bin/gh-gpgsign` | + +To check that these values are set correctly in a codespace, you can use the `git config --list --show-origin` command. Because {% data variables.product.prodname_github_codespaces %} sets this configuration at the system level, the required configuration settings should come from `/usr/local/etc/gitconfig`. + +```Shell +$ git config --list --show-origin +file:/usr/local/etc/gitconfig credential.helper=/.codespaces/bin/gitcredential_github.sh +file:/usr/local/etc/gitconfig user.name=Mona Lisa +file:/usr/local/etc/gitconfig gpg.program=/.codespaces/bin/gh-gpgsign +``` + +In addition to the values listed above, you may run into errors if the dotfiles used in your codespaces contain any of the following values. + +- The `user.signingkey` Git config value +- The `commit.gpgsign` Git config value +- A manually set `GITHUB_TOKEN` + +### Removing conflicting configuration + +If you want to keep automatic GPG verification for {% data variables.product.prodname_github_codespaces %} enabled, you will need to remove any conflicting configuration from the dotfiles used in your codespaces. + +For example, if the global `.gitconfig` file on your local machine contains a `gpg.program` value, and you have pushed this file to a dotfiles repository that is linked with {% data variables.product.prodname_github_codespaces %}, then you may want to remove `gpg.program` from this file and set it at the system level on your local machine instead. + +{% note %} + +**Note:** Any changes to your dotfiles repository will apply to new codespaces you create, but not to your existing codespaces. + +{% endnote %} + +1. On your local machine, open a terminal. +2. To remove the conflicting value from `~/.gitconfig` (Mac/Linux) or `C:\Users\YOUR-USER\.gitconfig` (Windows), use the `git config --global --unset` command. + + ```Shell + $ git config --global --unset gpg.program + ``` +3. Push the change to your dotfiles repository on {% data variables.product.prodname_dotcom %}. +4. Optionally, to keep your local configuration, set the value again in a Git configuration file that you do not push to your dotfiles repository. + + For example, you can use the `--system` flag to set the configuration in the system-level file at `PATH/etc/gitconfig`, where `PATH` is the directory in which Git is installed on your system. + + ```Shell + $ git config --system gpg.program gpg2 + ``` + +Alternatively, if your dotfiles repository contains an installation script in a recognized file such as `install.sh`, you can use the `$CODESPACES` environment variable to add conditional logic, such as only setting `gpg.program` when you are not in a codespace. In the following example, `-z "$CODESPACES"` returns `true` if you are not in a codespace. + +```Shell{:copy} +if [ -z "$CODESPACES" ]; then + git config --global gpg.program gpg2 +fi +``` + +## Further reading +- "[About commit signature verification](/authentication/managing-commit-signature-verification/about-commit-signature-verification)" +- [`git config`](https://git-scm.com/docs/git-config) in the official Git documentation \ No newline at end of file diff --git a/content/index.md b/content/index.md index 66d534b21217..eab0483aea80 100644 --- a/content/index.md +++ b/content/index.md @@ -17,6 +17,31 @@ redirect_from: - /articles - /common-issues-and-questions - /troubleshooting-common-issues + - /early-access/github/enforcing-best-practices-with-github-policies + - /github/enforcing-best-practices-with-github-policies/index + - /early-access/github/enforcing-best-practices-with-github-policies/about-github-policies + - /github/enforcing-best-practices-with-github-policies/about-github-policies + - /early-access/github/enforcing-best-practices-with-github-policies/constraints + - /github/enforcing-best-practices-with-github-policies/constraints + - /early-access/github/enforcing-best-practices-with-github-policies/contexts + - /github/enforcing-best-practices-with-github-policies/contexts + - /early-access/github/enforcing-best-practices-with-github-policies/expressions + - /github/enforcing-best-practices-with-github-policies/expressions + - /early-access/github/enforcing-best-practices-with-github-policies/getting-started + - /early-access/github/enforcing-best-practices-with-github-policies/github-policies-vision + - /github/enforcing-best-practices-with-github-policies/github-policies-vision + - /early-access/github/enforcing-best-practices-with-github-policies/onboarding + - /github/enforcing-best-practices-with-github-policies/onboarding + - /early-access/github/enforcing-best-practices-with-github-policies/overview + - /github/enforcing-best-practices-with-github-policies/overview + - /early-access/github/enforcing-best-practices-with-github-policies/release-notes + - /github/enforcing-best-practices-with-github-policies/release-notes + - /early-access/github/enforcing-best-practices-with-github-policies/resources + - /github/enforcing-best-practices-with-github-policies/resources + - /early-access/github/enforcing-best-practices-with-github-policies/sharing + - /github/enforcing-best-practices-with-github-policies/sharing + - /early-access/github/enforcing-best-practices-with-github-policies/syntax + - /github/enforcing-best-practices-with-github-policies/syntax versions: '*' children: - search diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 7a4f6280cea4..8610c24a3594 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -37108,11 +37108,21 @@ type Submodule { """ name: String! + """ + The name of the submodule in .gitmodules (Base64-encoded) + """ + nameRaw: Base64String! + """ The path in the superproject that this submodule is located in """ path: String! + """ + The path in the superproject that this submodule is located in (Base64-encoded) + """ + pathRaw: Base64String! + """ The commit revision of the subproject repository being tracked by the submodule """ @@ -39591,6 +39601,11 @@ type TreeEntry { """ name: String! + """ + Entry file name. (Base64-encoded) + """ + nameRaw: Base64String! + """ Entry file object. """ @@ -39606,6 +39621,11 @@ type TreeEntry { """ path: String + """ + The full path of the file. (Base64-encoded) + """ + pathRaw: Base64String + """ The Repository the tree entry belongs to """ diff --git a/data/graphql/ghec/schema.docs.graphql b/data/graphql/ghec/schema.docs.graphql index a4c298ae7efd..c46f8d2e7bb4 100644 --- a/data/graphql/ghec/schema.docs.graphql +++ b/data/graphql/ghec/schema.docs.graphql @@ -21124,6 +21124,16 @@ type Mutation { input: SubmitPullRequestReviewInput! ): SubmitPullRequestReviewPayload + """ + Transfer an organization from one enterprise to another enterprise. + """ + transferEnterpriseOrganization( + """ + Parameters for TransferEnterpriseOrganization + """ + input: TransferEnterpriseOrganizationInput! + ): TransferEnterpriseOrganizationPayload + """ Transfer an issue to a different repository """ @@ -26285,6 +26295,13 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr """ last: Int + """ + Filter sponsorships returned to those for the specified maintainers. That + is, the recipient of the sponsorship is a user or organization with one of + the given logins. + """ + maintainerLogins: [String!] + """ Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer. @@ -45111,6 +45128,13 @@ interface Sponsorable { """ last: Int + """ + Filter sponsorships returned to those for the specified maintainers. That + is, the recipient of the sponsorship is a user or organization with one of + the given logins. + """ + maintainerLogins: [String!] + """ Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer. @@ -45422,6 +45446,13 @@ type SponsorsListing implements Node { """ billingCountryOrRegion: String + """ + The email address used by GitHub to contact the sponsorable about their GitHub + Sponsors profile. Will only return a value when queried by the maintainer + themselves, or by an admin of the sponsorable organization. + """ + contactEmailAddress: String + """ Identifies the date and time when the object was created. """ @@ -46624,11 +46655,21 @@ type Submodule { """ name: String! + """ + The name of the submodule in .gitmodules (Base64-encoded) + """ + nameRaw: Base64String! + """ The path in the superproject that this submodule is located in """ path: String! + """ + The path in the superproject that this submodule is located in (Base64-encoded) + """ + pathRaw: Base64String! + """ The commit revision of the subproject repository being tracked by the submodule """ @@ -49066,6 +49107,41 @@ enum TrackedIssueStates { OPEN } +""" +Autogenerated input type of TransferEnterpriseOrganization +""" +input TransferEnterpriseOrganizationInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the enterprise where the organization should be transferred. + """ + destinationEnterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) + + """ + The ID of the organization to transfer. + """ + organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) +} + +""" +Autogenerated return type of TransferEnterpriseOrganization +""" +type TransferEnterpriseOrganizationPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The organization for which a transfer was initiated. + """ + organization: Organization +} + """ Autogenerated input type of TransferIssue """ @@ -49202,6 +49278,11 @@ type TreeEntry { """ name: String! + """ + Entry file name. (Base64-encoded) + """ + nameRaw: Base64String! + """ Entry file object. """ @@ -49217,6 +49298,11 @@ type TreeEntry { """ path: String + """ + The full path of the file. (Base64-encoded) + """ + pathRaw: Base64String + """ The Repository the tree entry belongs to """ @@ -53942,6 +54028,13 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectNextOwn """ last: Int + """ + Filter sponsorships returned to those for the specified maintainers. That + is, the recipient of the sponsorship is a user or organization with one of + the given logins. + """ + maintainerLogins: [String!] + """ Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer. diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index a4c298ae7efd..c46f8d2e7bb4 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -21124,6 +21124,16 @@ type Mutation { input: SubmitPullRequestReviewInput! ): SubmitPullRequestReviewPayload + """ + Transfer an organization from one enterprise to another enterprise. + """ + transferEnterpriseOrganization( + """ + Parameters for TransferEnterpriseOrganization + """ + input: TransferEnterpriseOrganizationInput! + ): TransferEnterpriseOrganizationPayload + """ Transfer an issue to a different repository """ @@ -26285,6 +26295,13 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr """ last: Int + """ + Filter sponsorships returned to those for the specified maintainers. That + is, the recipient of the sponsorship is a user or organization with one of + the given logins. + """ + maintainerLogins: [String!] + """ Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer. @@ -45111,6 +45128,13 @@ interface Sponsorable { """ last: Int + """ + Filter sponsorships returned to those for the specified maintainers. That + is, the recipient of the sponsorship is a user or organization with one of + the given logins. + """ + maintainerLogins: [String!] + """ Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer. @@ -45422,6 +45446,13 @@ type SponsorsListing implements Node { """ billingCountryOrRegion: String + """ + The email address used by GitHub to contact the sponsorable about their GitHub + Sponsors profile. Will only return a value when queried by the maintainer + themselves, or by an admin of the sponsorable organization. + """ + contactEmailAddress: String + """ Identifies the date and time when the object was created. """ @@ -46624,11 +46655,21 @@ type Submodule { """ name: String! + """ + The name of the submodule in .gitmodules (Base64-encoded) + """ + nameRaw: Base64String! + """ The path in the superproject that this submodule is located in """ path: String! + """ + The path in the superproject that this submodule is located in (Base64-encoded) + """ + pathRaw: Base64String! + """ The commit revision of the subproject repository being tracked by the submodule """ @@ -49066,6 +49107,41 @@ enum TrackedIssueStates { OPEN } +""" +Autogenerated input type of TransferEnterpriseOrganization +""" +input TransferEnterpriseOrganizationInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the enterprise where the organization should be transferred. + """ + destinationEnterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) + + """ + The ID of the organization to transfer. + """ + organizationId: ID! @possibleTypes(concreteTypes: ["Organization"]) +} + +""" +Autogenerated return type of TransferEnterpriseOrganization +""" +type TransferEnterpriseOrganizationPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The organization for which a transfer was initiated. + """ + organization: Organization +} + """ Autogenerated input type of TransferIssue """ @@ -49202,6 +49278,11 @@ type TreeEntry { """ name: String! + """ + Entry file name. (Base64-encoded) + """ + nameRaw: Base64String! + """ Entry file object. """ @@ -49217,6 +49298,11 @@ type TreeEntry { """ path: String + """ + The full path of the file. (Base64-encoded) + """ + pathRaw: Base64String + """ The Repository the tree entry belongs to """ @@ -53942,6 +54028,13 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectNextOwn """ last: Int + """ + Filter sponsorships returned to those for the specified maintainers. That + is, the recipient of the sponsorship is a user or organization with one of + the given logins. + """ + maintainerLogins: [String!] + """ Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer. diff --git a/data/release-notes/enterprise-server/3-7/0.yml b/data/release-notes/enterprise-server/3-7/0.yml index dd075993a779..de0e7f260615 100644 --- a/data/release-notes/enterprise-server/3-7/0.yml +++ b/data/release-notes/enterprise-server/3-7/0.yml @@ -325,6 +325,10 @@ sections: - During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. deprecations: + # https://github.com/github/enterprise-releases/issues/3217 + - | + **Upcoming deprecation**: In GitHub Enterprise Server 3.8 and later, unsecure algorithms will be disabled for SSH connections to the administrative shell. + # https://github.com/github/releases/issues/2395 - Commit comments, which are comments that users add directly to a commit outside of a pull request, no longer appear in the pull request timeline. Users could not reply to or resolve these comments. The Timeline events REST API and the GraphQL API's `PullRequest` object also no longer return commit comments. diff --git a/data/reusables/codespaces/gpg-in-active-codespaces.md b/data/reusables/codespaces/gpg-in-active-codespaces.md new file mode 100644 index 000000000000..932415c67dec --- /dev/null +++ b/data/reusables/codespaces/gpg-in-active-codespaces.md @@ -0,0 +1 @@ +Once you enable GPG verification, it will automatically take effect in any new codespaces you create from the relevant repositories. To have GPG verification take effect in an existing active codespace, you will need to stop and restart the codespace. For more information, see "[Stopping and starting a codespace](/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace)." \ No newline at end of file diff --git a/data/reusables/saml/assert-the-administrator-attribute.md b/data/reusables/saml/assert-the-administrator-attribute.md index e94ebc5b94ed..9a97be606125 100644 --- a/data/reusables/saml/assert-the-administrator-attribute.md +++ b/data/reusables/saml/assert-the-administrator-attribute.md @@ -1 +1 @@ -To make a person an enterprise owner, you must delegate ownership permission in your IdP. Include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." +To make a person an enterprise owner, you must delegate access from your IdP. If you use Azure AD and SCIM, assign the enterprise owner role to the user. For other IdPs, include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." For more information about authentication and provisioning using Azure AD, see "[Configuring authentication and provisioning for your enterprise using Azure AD](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad)." diff --git a/lib/graphql/static/changelog.json b/lib/graphql/static/changelog.json index 153c273b57a2..e1873a5e1fa6 100644 --- a/lib/graphql/static/changelog.json +++ b/lib/graphql/static/changelog.json @@ -1,4 +1,27 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Type TransferEnterpriseOrganizationInput was added

", + "

Type TransferEnterpriseOrganizationPayload was added

", + "

Field transferEnterpriseOrganization was added to object type Mutation

", + "

Argument 'maintainerLogins: [String!]added to fieldOrganization.sponsorshipsAsSponsor'

", + "

Argument 'maintainerLogins: [String!]added to fieldSponsorable.sponsorshipsAsSponsor'

", + "

Field contactEmailAddress was added to object type SponsorsListing

", + "

Field nameRaw was added to object type Submodule

", + "

Field pathRaw was added to object type Submodule

", + "

Field nameRaw was added to object type TreeEntry

", + "

Field pathRaw was added to object type TreeEntry

", + "

Argument 'maintainerLogins: [String!]added to fieldUser.sponsorshipsAsSponsor'

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2022-11-16" + }, { "schemaChanges": [ { diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index 85d64698e98b..74581d7624fb 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -5618,6 +5618,40 @@ } ] }, + { + "name": "transferEnterpriseOrganization", + "kind": "mutations", + "id": "transferenterpriseorganization", + "href": "/graphql/reference/mutations#transferenterpriseorganization", + "description": "

Transfer an organization from one enterprise to another enterprise.

", + "inputFields": [ + { + "name": "input", + "type": "TransferEnterpriseOrganizationInput!", + "id": "transferenterpriseorganizationinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#transferenterpriseorganizationinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "organization", + "type": "Organization", + "id": "organization", + "kind": "objects", + "href": "/graphql/reference/objects#organization", + "description": "

The organization for which a transfer was initiated.

" + } + ] + }, { "name": "transferIssue", "kind": "mutations", @@ -37683,6 +37717,16 @@ "href": "/graphql/reference/scalars#int" } }, + { + "name": "maintainerLogins", + "description": "

Filter sponsorships returned to those for the specified maintainers. That\nis, the recipient of the sponsorship is a user or organization with one of\nthe given logins.

", + "type": { + "name": "[String!]", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, { "name": "orderBy", "description": "

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

", @@ -61717,6 +61761,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "contactEmailAddress", + "description": "

The email address used by GitHub to contact the sponsorable about their GitHub\nSponsors profile. Will only return a value when queried by the maintainer\nthemselves, or by an admin of the sponsorable organization.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, { "name": "createdAt", "description": "

Identifies the date and time when the object was created.

", @@ -63155,6 +63207,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "nameRaw", + "description": "

The name of the submodule in .gitmodules (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "path", "description": "

The path in the superproject that this submodule is located in.

", @@ -63163,6 +63223,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "pathRaw", + "description": "

The path in the superproject that this submodule is located in (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "subprojectCommitOid", "description": "

The commit revision of the subproject repository being tracked by the submodule.

", @@ -67218,6 +67286,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "nameRaw", + "description": "

Entry file name. (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "object", "description": "

Entry file object.

", @@ -67242,6 +67318,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "pathRaw", + "description": "

The full path of the file. (Base64-encoded).

", + "type": "Base64String", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "repository", "description": "

The Repository the tree entry belongs to.

", @@ -70187,6 +70271,16 @@ "href": "/graphql/reference/scalars#int" } }, + { + "name": "maintainerLogins", + "description": "

Filter sponsorships returned to those for the specified maintainers. That\nis, the recipient of the sponsorship is a user or organization with one of\nthe given logins.

", + "type": { + "name": "[String!]", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, { "name": "orderBy", "description": "

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

", @@ -74795,6 +74889,16 @@ "href": "/graphql/reference/scalars#int" } }, + { + "name": "maintainerLogins", + "description": "

Filter sponsorships returned to those for the specified maintainers. That\nis, the recipient of the sponsorship is a user or organization with one of\nthe given logins.

", + "type": { + "name": "[String!]", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, { "name": "orderBy", "description": "

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

", @@ -89494,6 +89598,41 @@ } ] }, + { + "name": "TransferEnterpriseOrganizationInput", + "kind": "inputObjects", + "id": "transferenterpriseorganizationinput", + "href": "/graphql/reference/input-objects#transferenterpriseorganizationinput", + "description": "

Autogenerated input type of TransferEnterpriseOrganization.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "destinationEnterpriseId", + "description": "

The ID of the enterprise where the organization should be transferred.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "organizationId", + "description": "

The ID of the organization to transfer.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "TransferIssueInput", "kind": "inputObjects", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 22efb8d6e5dc..0b036ba9b496 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -51185,6 +51185,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "nameRaw", + "description": "

The name of the submodule in .gitmodules (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "path", "description": "

The path in the superproject that this submodule is located in.

", @@ -51193,6 +51201,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "pathRaw", + "description": "

The path in the superproject that this submodule is located in (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "subprojectCommitOid", "description": "

The commit revision of the subproject repository being tracked by the submodule.

", @@ -55136,6 +55152,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "nameRaw", + "description": "

Entry file name. (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "object", "description": "

Entry file object.

", @@ -55160,6 +55184,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "pathRaw", + "description": "

The full path of the file. (Base64-encoded).

", + "type": "Base64String", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "repository", "description": "

The Repository the tree entry belongs to.

", diff --git a/lib/graphql/static/schema-ghec.json b/lib/graphql/static/schema-ghec.json index 85d64698e98b..74581d7624fb 100644 --- a/lib/graphql/static/schema-ghec.json +++ b/lib/graphql/static/schema-ghec.json @@ -5618,6 +5618,40 @@ } ] }, + { + "name": "transferEnterpriseOrganization", + "kind": "mutations", + "id": "transferenterpriseorganization", + "href": "/graphql/reference/mutations#transferenterpriseorganization", + "description": "

Transfer an organization from one enterprise to another enterprise.

", + "inputFields": [ + { + "name": "input", + "type": "TransferEnterpriseOrganizationInput!", + "id": "transferenterpriseorganizationinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#transferenterpriseorganizationinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "organization", + "type": "Organization", + "id": "organization", + "kind": "objects", + "href": "/graphql/reference/objects#organization", + "description": "

The organization for which a transfer was initiated.

" + } + ] + }, { "name": "transferIssue", "kind": "mutations", @@ -37683,6 +37717,16 @@ "href": "/graphql/reference/scalars#int" } }, + { + "name": "maintainerLogins", + "description": "

Filter sponsorships returned to those for the specified maintainers. That\nis, the recipient of the sponsorship is a user or organization with one of\nthe given logins.

", + "type": { + "name": "[String!]", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, { "name": "orderBy", "description": "

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

", @@ -61717,6 +61761,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "contactEmailAddress", + "description": "

The email address used by GitHub to contact the sponsorable about their GitHub\nSponsors profile. Will only return a value when queried by the maintainer\nthemselves, or by an admin of the sponsorable organization.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, { "name": "createdAt", "description": "

Identifies the date and time when the object was created.

", @@ -63155,6 +63207,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "nameRaw", + "description": "

The name of the submodule in .gitmodules (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "path", "description": "

The path in the superproject that this submodule is located in.

", @@ -63163,6 +63223,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "pathRaw", + "description": "

The path in the superproject that this submodule is located in (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "subprojectCommitOid", "description": "

The commit revision of the subproject repository being tracked by the submodule.

", @@ -67218,6 +67286,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "nameRaw", + "description": "

Entry file name. (Base64-encoded).

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "object", "description": "

Entry file object.

", @@ -67242,6 +67318,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "pathRaw", + "description": "

The full path of the file. (Base64-encoded).

", + "type": "Base64String", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, { "name": "repository", "description": "

The Repository the tree entry belongs to.

", @@ -70187,6 +70271,16 @@ "href": "/graphql/reference/scalars#int" } }, + { + "name": "maintainerLogins", + "description": "

Filter sponsorships returned to those for the specified maintainers. That\nis, the recipient of the sponsorship is a user or organization with one of\nthe given logins.

", + "type": { + "name": "[String!]", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, { "name": "orderBy", "description": "

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

", @@ -74795,6 +74889,16 @@ "href": "/graphql/reference/scalars#int" } }, + { + "name": "maintainerLogins", + "description": "

Filter sponsorships returned to those for the specified maintainers. That\nis, the recipient of the sponsorship is a user or organization with one of\nthe given logins.

", + "type": { + "name": "[String!]", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, { "name": "orderBy", "description": "

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

", @@ -89494,6 +89598,41 @@ } ] }, + { + "name": "TransferEnterpriseOrganizationInput", + "kind": "inputObjects", + "id": "transferenterpriseorganizationinput", + "href": "/graphql/reference/input-objects#transferenterpriseorganizationinput", + "description": "

Autogenerated input type of TransferEnterpriseOrganization.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "destinationEnterpriseId", + "description": "

The ID of the enterprise where the organization should be transferred.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "organizationId", + "description": "

The ID of the organization to transfer.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "TransferIssueInput", "kind": "inputObjects", diff --git a/lib/redirects/static/client-side-rest-api-redirects.json b/lib/redirects/static/client-side-rest-api-redirects.json index 5a52f01a952b..b74131ae9c67 100644 --- a/lib/redirects/static/client-side-rest-api-redirects.json +++ b/lib/redirects/static/client-side-rest-api-redirects.json @@ -538,8 +538,44 @@ "/rest/repos#autolinks": "/rest/repos/autolinks", "/rest/repos#enable-automated-security-fixes": "/rest/repos/repos#enable-automated-security-fixes", "/rest/repos#disable-automated-security-fixes": "/rest/repos/repos#disable-automated-security-fixes", + "/rest/branches/branches#list-branches": "/rest/branches/branches#list-branches", "/rest/branches#branches": "/rest/branches/branches", + "/rest/branches/branches#get-a-branch": "/rest/branches/branches#get-a-branch", + "/rest/branches/branch-protection#get-branch-protection": "/rest/branches/branch-protection#get-branch-protection", "/rest/branches#branch-protection": "/rest/branches/branch-protection", + "/rest/branches/branch-protection#update-branch-protection": "/rest/branches/branch-protection#update-branch-protection", + "/rest/branches/branch-protection#delete-branch-protection": "/rest/branches/branch-protection#delete-branch-protection", + "/rest/branches/branch-protection#get-admin-branch-protection": "/rest/branches/branch-protection#get-admin-branch-protection", + "/rest/branches/branch-protection#set-admin-branch-protection": "/rest/branches/branch-protection#set-admin-branch-protection", + "/rest/branches/branch-protection#delete-admin-branch-protection": "/rest/branches/branch-protection#delete-admin-branch-protection", + "/rest/branches/branch-protection#get-pull-request-review-protection": "/rest/branches/branch-protection#get-pull-request-review-protection", + "/rest/branches/branch-protection#update-pull-request-review-protection": "/rest/branches/branch-protection#update-pull-request-review-protection", + "/rest/branches/branch-protection#delete-pull-request-review-protection": "/rest/branches/branch-protection#delete-pull-request-review-protection", + "/rest/branches/branch-protection#get-commit-signature-protection": "/rest/branches/branch-protection#get-commit-signature-protection", + "/rest/branches/branch-protection#create-commit-signature-protection": "/rest/branches/branch-protection#create-commit-signature-protection", + "/rest/branches/branch-protection#delete-commit-signature-protection": "/rest/branches/branch-protection#delete-commit-signature-protection", + "/rest/branches/branch-protection#get-status-checks-protection": "/rest/branches/branch-protection#get-status-checks-protection", + "/rest/branches/branch-protection#update-status-check-protection": "/rest/branches/branch-protection#update-status-check-protection", + "/rest/branches/branch-protection#remove-status-check-protection": "/rest/branches/branch-protection#remove-status-check-protection", + "/rest/branches/branch-protection#get-all-status-check-contexts": "/rest/branches/branch-protection#get-all-status-check-contexts", + "/rest/branches/branch-protection#add-status-check-contexts": "/rest/branches/branch-protection#add-status-check-contexts", + "/rest/branches/branch-protection#set-status-check-contexts": "/rest/branches/branch-protection#set-status-check-contexts", + "/rest/branches/branch-protection#remove-status-check-contexts": "/rest/branches/branch-protection#remove-status-check-contexts", + "/rest/branches/branch-protection#get-access-restrictions": "/rest/branches/branch-protection#get-access-restrictions", + "/rest/branches/branch-protection#delete-access-restrictions": "/rest/branches/branch-protection#delete-access-restrictions", + "/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch": "/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch", + "/rest/branches/branch-protection#add-app-access-restrictions": "/rest/branches/branch-protection#add-app-access-restrictions", + "/rest/branches/branch-protection#set-app-access-restrictions": "/rest/branches/branch-protection#set-app-access-restrictions", + "/rest/branches/branch-protection#remove-app-access-restrictions": "/rest/branches/branch-protection#remove-app-access-restrictions", + "/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch": "/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch", + "/rest/branches/branch-protection#add-team-access-restrictions": "/rest/branches/branch-protection#add-team-access-restrictions", + "/rest/branches/branch-protection#set-team-access-restrictions": "/rest/branches/branch-protection#set-team-access-restrictions", + "/rest/branches/branch-protection#remove-team-access-restrictions": "/rest/branches/branch-protection#remove-team-access-restrictions", + "/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch": "/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch", + "/rest/branches/branch-protection#add-user-access-restrictions": "/rest/branches/branch-protection#add-user-access-restrictions", + "/rest/branches/branch-protection#set-user-access-restrictions": "/rest/branches/branch-protection#set-user-access-restrictions", + "/rest/branches/branch-protection#remove-user-access-restrictions": "/rest/branches/branch-protection#remove-user-access-restrictions", + "/rest/branches/branches#rename-a-branch": "/rest/branches/branches#rename-a-branch", "/rest/checks#create-a-check-run": "/rest/checks/runs#create-a-check-run", "/rest/checks#runs": "/rest/checks/runs", "/rest/checks#get-a-check-run": "/rest/checks/runs#get-a-check-run", @@ -710,6 +746,8 @@ "/rest/repos#enable-git-lfs-for-a-repository": "/rest/repos/lfs#enable-git-lfs-for-a-repository", "/rest/repos#lfs": "/rest/repos/lfs", "/rest/repos#disable-git-lfs-for-a-repository": "/rest/repos/lfs#disable-git-lfs-for-a-repository", + "/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository": "/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository", + "/rest/branches/branches#merge-a-branch": "/rest/branches/branches#merge-a-branch", "/rest/issues#list-milestones": "/rest/issues/milestones#list-milestones", "/rest/issues#milestones": "/rest/issues/milestones", "/rest/issues#create-a-milestone": "/rest/issues/milestones#create-a-milestone", diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index f0f5d8a201d3..4159c44a83d2 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -110066,6 +110066,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -110534,7 +110543,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -174908,7 +174922,7 @@ "enabledForGitHubApps": false, "codeExamples": [ { - "key": "202", + "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", @@ -174918,7 +174932,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -184744,7 +184763,7 @@ "enabledForGitHubApps": false, "codeExamples": [ { - "key": "202", + "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", @@ -184756,7 +184775,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -351437,6 +351461,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -351949,7 +351982,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -460374,7 +460412,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -471156,10 +471199,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -471690,10 +471740,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -472282,10 +472339,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -507606,7 +507670,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/decorated/ghec.json b/lib/rest/static/decorated/ghec.json index 3dfd214c36ab..ffbd4ddccd4e 100644 --- a/lib/rest/static/decorated/ghec.json +++ b/lib/rest/static/decorated/ghec.json @@ -110516,6 +110516,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -110984,7 +110993,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -175358,7 +175372,7 @@ "enabledForGitHubApps": false, "codeExamples": [ { - "key": "202", + "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", @@ -175368,7 +175382,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -185194,7 +185213,7 @@ "enabledForGitHubApps": false, "codeExamples": [ { - "key": "202", + "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", @@ -185206,7 +185225,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -229254,6 +229278,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -229276,6 +229306,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -343176,6 +343209,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -343198,6 +343237,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -353397,6 +353439,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -353909,7 +353960,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -462334,7 +462390,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -462925,10 +462986,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -462937,7 +462994,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -462946,6 +463002,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -463056,6 +463115,7 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", "properties": { "value": { "type": "string" @@ -463065,14 +463125,31 @@ } } } + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } } }, "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -463278,10 +463355,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -463290,7 +463363,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -463299,6 +463371,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -463409,6 +463484,7 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", "properties": { "value": { "type": "string" @@ -463418,14 +463494,31 @@ } } } + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } } }, "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -463712,10 +463805,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -463724,7 +463813,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -463733,6 +463821,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -463843,6 +463934,7 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", "properties": { "value": { "type": "string" @@ -463852,14 +463944,31 @@ } } } + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } } }, "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -464050,10 +464159,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -464062,7 +464167,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -464071,6 +464175,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -464181,6 +464288,7 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", "properties": { "value": { "type": "string" @@ -464190,14 +464298,31 @@ } } } + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } } }, "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -464476,10 +464601,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -464488,7 +464609,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -464497,6 +464617,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -464607,10 +464730,31 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "roles": { + "type": "array", + "items": { + "type": "object", "properties": { "value": { "type": "string" }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, "display": { "type": "string" } @@ -464621,9 +464765,6 @@ "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -464850,10 +464991,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -464862,7 +464999,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -464871,6 +465007,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -464981,10 +465120,31 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "roles": { + "type": "array", + "items": { + "type": "object", "properties": { "value": { "type": "string" }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, "display": { "type": "string" } @@ -464995,9 +465155,6 @@ "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -475506,10 +475663,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -476040,10 +476204,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -476632,10 +476803,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -513524,7 +513702,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 830314d6e46f..8f5917fc556d 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -98074,6 +98074,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -98542,7 +98551,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -166699,6 +166713,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -166721,6 +166741,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -276949,6 +276972,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -276971,6 +277000,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -283237,6 +283269,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -283749,7 +283790,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -379618,7 +379664,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -388332,10 +388383,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -388664,10 +388722,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -389051,10 +389116,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -421997,7 +422069,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 79e7db65dd99..428c433623ef 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -98053,6 +98053,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -98521,7 +98530,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -174242,6 +174256,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -174264,6 +174284,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -295073,6 +295096,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -295095,6 +295124,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -301448,6 +301480,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -301960,7 +302001,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -397979,7 +398025,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -407811,10 +407862,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -408143,10 +408201,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -408530,10 +408595,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -441548,7 +441620,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 76d829036a30..a94e603710ec 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -103725,6 +103725,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -104193,7 +104202,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -181398,6 +181412,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -181420,6 +181440,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -302235,6 +302258,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -302257,6 +302286,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -308610,6 +308642,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -309122,7 +309163,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -405278,7 +405324,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -415437,10 +415488,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -415774,10 +415832,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -416166,10 +416231,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -449216,7 +449288,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index 3625446d36c9..7e7df5445c28 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -106242,6 +106242,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -106710,7 +106719,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -184436,6 +184450,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -184458,6 +184478,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -311586,6 +311609,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -311608,6 +311637,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -317961,6 +317993,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -318473,7 +318514,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -416420,7 +416466,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -427129,10 +427180,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -427650,10 +427708,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -428226,10 +428291,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -462555,7 +462627,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.7.json b/lib/rest/static/decorated/ghes-3.7.json index ebe508f96fea..954d3ab941dd 100644 --- a/lib/rest/static/decorated/ghes-3.7.json +++ b/lib/rest/static/decorated/ghes-3.7.json @@ -107216,6 +107216,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -107684,7 +107693,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -187248,6 +187262,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -187270,6 +187290,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -314670,6 +314693,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -314692,6 +314721,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -321411,6 +321443,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -321923,7 +321964,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -420246,7 +420292,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -431008,10 +431059,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -431529,10 +431587,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -432105,10 +432170,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -466941,7 +467013,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 2158c015190e..134a48413230 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -72686,6 +72686,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -73153,7 +73162,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -145263,6 +145277,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -145285,6 +145305,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -254735,6 +254758,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -254757,6 +254786,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -260592,6 +260624,15 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" } ], "bodyParameters": [], @@ -261103,7 +261144,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -355046,7 +355092,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], @@ -363977,10 +364028,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -364316,10 +364374,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -364717,10 +364782,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -398062,7 +398134,12 @@ }, "response": { "statusCode": "202", - "description": "

Accepted

" + "contentType": "application/json", + "description": "

Accepted

", + "example": null, + "schema": { + "type": "object" + } } } ], diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 1adb2839f1a2..0a9e1cb7f78d 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -1553,6 +1553,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -2281,6 +2289,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -87695,6 +87708,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -88459,6 +88480,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -98382,6 +98408,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -177167,7 +177198,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#list-branches" + "url": "https://docs.github.com/rest/branches/branches#list-branches" }, "parameters": [ { @@ -179288,8 +179319,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -179303,7 +179333,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -182202,8 +182232,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -182217,7 +182246,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -184453,8 +184482,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -184466,7 +184495,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -186905,8 +186934,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -186918,7 +186947,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -186984,8 +187013,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -186999,7 +187028,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -187075,8 +187104,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -187088,7 +187117,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -187164,8 +187193,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -187177,7 +187206,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -187243,8 +187272,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -187258,7 +187287,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -188864,8 +188893,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -188877,7 +188906,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -190673,8 +190702,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -190686,7 +190715,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -190752,8 +190781,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -190767,7 +190796,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -190869,8 +190898,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -190882,7 +190911,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -190984,8 +191013,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -190997,7 +191026,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -191063,8 +191092,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -191078,7 +191107,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -191227,8 +191256,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -191240,7 +191269,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -191518,8 +191547,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -191531,7 +191560,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -191571,8 +191600,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -191586,7 +191615,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -191669,8 +191698,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -191682,7 +191711,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -191917,8 +191946,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -191930,7 +191959,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -192137,8 +192166,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -192150,7 +192179,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -192356,8 +192385,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -192371,7 +192400,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -192835,8 +192864,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -192848,7 +192877,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -192888,8 +192917,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -192903,7 +192932,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -193348,8 +193377,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -193361,7 +193390,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -193902,8 +193931,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -193915,7 +193944,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -194456,8 +194485,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -194469,7 +194498,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -195009,8 +195038,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -195024,7 +195053,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -195317,8 +195346,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -195330,7 +195359,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -195721,8 +195750,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -195734,7 +195763,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -196125,8 +196154,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -196138,7 +196167,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -196528,8 +196557,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -196543,7 +196572,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -196803,8 +196832,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -196816,7 +196845,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -197173,8 +197202,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -197186,7 +197215,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -197543,8 +197572,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -197556,7 +197585,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -197912,8 +197941,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -197927,7 +197956,7 @@ "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#rename-a-branch" + "url": "https://docs.github.com/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -200922,8 +200951,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -278421,6 +278449,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -351583,6 +351616,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -351888,7 +351926,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -351984,8 +352022,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -351999,7 +352036,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -352959,8 +352996,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -412751,10 +412787,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -413355,10 +413398,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -413953,10 +414003,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -415333,6 +415390,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -415456,6 +415518,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -415772,6 +415839,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -458938,236 +459010,241 @@ "application/json": { "schema": { "type": "object" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": null - } - } - }, - "/user/codespaces/{codespace_name}/exports": { - "post": { - "summary": "Export a codespace for the authenticated user", - "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/export-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Fetches information about an export of a codespace.", - "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", - "properties": { - "state": { - "type": [ - "string", - "null" - ], - "description": "State of the latest export", - "examples": [ - "succeeded | failed | in_progress" - ] - }, - "completed_at": { - "description": "Completion time of the last export operation", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-01-01T19:01:12Z" - ] - }, - "branch": { - "type": [ - "string", - "null" - ], - "description": "Name of the exported branch", - "examples": [ - "codespace-monalisa-octocat-hello-world-g4wpq6h95q" - ] - }, - "sha": { - "type": [ - "string", - "null" - ], - "description": "Git commit SHA of the exported branch", - "examples": [ - "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" - ] - }, - "id": { - "type": "string", - "description": "Id for the export details", - "examples": [ - "latest" - ] - }, - "export_url": { - "type": "string", - "description": "Url for fetching export details", - "examples": [ - "https://api.github.com/user/codespaces/:name/exports/latest" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "description": "Web url for the exported branch", - "examples": [ - "https://github.com/octocat/hello-world/tree/:branch" - ] - } - } }, "examples": { "default": { - "value": { - "state": "succeeded", - "completed_at": "2022-01-01T14:59:22Z", - "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", - "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", - "id": "latest", - "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" - } + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": null + } + } + }, + "/user/codespaces/{codespace_name}/exports": { + "post": { + "summary": "Export a codespace for the authenticated user", + "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/export-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Fetches information about an export of a codespace.", + "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", + "properties": { + "state": { + "type": [ + "string", + "null" + ], + "description": "State of the latest export", + "examples": [ + "succeeded | failed | in_progress" + ] + }, + "completed_at": { + "description": "Completion time of the last export operation", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-01-01T19:01:12Z" + ] + }, + "branch": { + "type": [ + "string", + "null" + ], + "description": "Name of the exported branch", + "examples": [ + "codespace-monalisa-octocat-hello-world-g4wpq6h95q" + ] + }, + "sha": { + "type": [ + "string", + "null" + ], + "description": "Git commit SHA of the exported branch", + "examples": [ + "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" + ] + }, + "id": { + "type": "string", + "description": "Id for the export details", + "examples": [ + "latest" + ] + }, + "export_url": { + "type": "string", + "description": "Url for fetching export details", + "examples": [ + "https://api.github.com/user/codespaces/:name/exports/latest" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "description": "Web url for the exported branch", + "examples": [ + "https://github.com/octocat/hello-world/tree/:branch" + ] + } + } + }, + "examples": { + "default": { + "value": { + "state": "succeeded", + "completed_at": "2022-01-01T14:59:22Z", + "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", + "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", + "id": "latest", + "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" + } } } } @@ -549492,13 +549569,13 @@ } } }, - "check-suite-completed": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -549563,671 +549640,2210 @@ "content": { "application/json": { "schema": { - "title": "check_suite completed event", + "title": "Check Run Requested Action Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "completed" - ] - }, - "actions_meta": { - "type": [ - "object", - "null" + "requested_action" ] }, - "check_suite": { - "description": "The [check_suite](https://docs.github.com/rest/reference/checks#suites).", + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { - "after": { - "type": [ - "string", - "null" + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } ] }, - "app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { - "created_at": { + "after": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" + ] }, - "description": { + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "before": { "type": [ "string", "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "merge_group", - "pull_request_review_thread", - "workflow_job", - "merge_queue_entry", - "security_and_analysis", - "projects_v2_item", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { + "conclusion": { "type": [ "string", "null" ], - "format": "uri" + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], + "examples": [ + "neutral" + ] }, - "html_url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "id": { - "description": "Unique identifier of the GitHub app", + "head_branch": { "type": [ - "integer", + "string", "null" + ], + "examples": [ + "master" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "id": { + "type": "integer", + "examples": [ + 5 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } }, - "email": { - "type": [ - "string", - "null" + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 ] }, - "events_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "followers_url": { + "name": { "type": "string", - "format": "uri" + "examples": [ + "Hello-World" + ] }, - "following_url": { + "full_name": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat/Hello-World" + ] }, - "gists_url": { - "type": "string", - "format": "uri-template" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "gravatar_id": { - "type": "string" + "private": { + "type": "boolean" }, "html_url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "name": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] }, - "node_id": { - "type": "string" + "fork": { + "type": "boolean" }, - "organizations_url": { + "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "received_events_url": { + "archive_url": { "type": "string", - "format": "uri" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "repos_url": { + "assignees_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] }, - "starred_url": { + "blobs_url": { "type": "string", - "format": "uri-template" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "subscriptions_url": { + "branches_url": { "type": "string", - "format": "uri" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "type": { + "collaborators_url": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { + "comments_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "administration": { + "commits_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "checks": { + "compare_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "content_references": { + "contents_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "contents": { + "contributors_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "deployments": { + "deployments_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "discussions": { + "downloads_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "emails": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "environments": { + "forks_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "issues": { + "git_commits_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "keys": { + "git_refs_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "members": { + "git_tags_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "metadata": { + "git_url": { + "type": "string" + }, + "issue_comment_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "organization_administration": { + "issue_events_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "organization_hooks": { + "issues_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "organization_packages": { + "keys_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "organization_plan": { + "labels_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "organization_projects": { + "languages_url": { "type": "string", - "enum": [ - "read", - "write", - "admin" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organization_secrets": { + "merges_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "organization_self_hosted_runners": { + "milestones_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "organization_user_blocking": { + "notifications_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "packages": { + "pulls_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "pages": { + "releases_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "pull_requests": { + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "repository_hooks": { + "statuses_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "repository_projects": { + "subscribers_url": { "type": "string", - "enum": [ - "read", - "write", - "admin" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "secret_scanning_alerts": { + "subscription_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "secrets": { + "tags_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "security_events": { + "teams_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "security_scanning_alert": { + "trees_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" ] }, - "statuses": { + "hooks_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" ] }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" + "language": { + "type": [ + "string", + "null" ] }, - "workflows": { + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] } - } + }, + "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" + ] }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] }, "updated_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time" + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] + } }, - "before": { + "completed_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" ] }, - "check_runs_url": { - "type": "string", - "format": "uri" - }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", "type": [ "string", "null" ], "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", "success", "failure", "neutral", "cancelled", + "skipped", "timed_out", "action_required", - "stale", - null, - "skipped", - "startup_failure" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "head_branch": { - "description": "The head branch name the changes are on.", - "type": [ - "string", - "null" + null + ], + "examples": [ + "neutral" ] }, - "head_commit": { - "title": "SimpleCommit", + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" ] }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 ] }, - "id": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] }, - "message": { - "type": "string" + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] }, - "timestamp": { - "type": "string" + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] }, - "tree_id": { - "type": "string" + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example" + ] + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] } }, "required": [ "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "details_url": { + "type": "string", + "examples": [ + "https://example.com" + ] + }, + "external_id": { + "type": "string", + "examples": [ + "42" ] }, "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string" + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] }, "id": { - "type": "integer" + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] }, - "latest_check_runs_count": { - "type": "integer" + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] }, "pull_requests": { - "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", "type": "array", "items": { - "title": "Check Run Pull Request", + "title": "Pull Request Minimal", "type": "object", "properties": { - "base": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { "type": "object", "properties": { "ref": { "type": "string" }, + "sha": { + "type": "string" + }, "repo": { - "title": "Repo Ref", "type": "object", "properties": { "id": { "type": "integer" }, - "name": { + "url": { "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "name": { + "type": "string" } }, "required": [ @@ -550235,9 +551851,6 @@ "url", "name" ] - }, - "sha": { - "type": "string" } }, "required": [ @@ -550246,25 +551859,26 @@ "repo" ] }, - "head": { + "base": { "type": "object", "properties": { "ref": { "type": "string" }, + "sha": { + "type": "string" + }, "repo": { - "title": "Repo Ref", "type": "object", "properties": { "id": { "type": "integer" }, - "name": { + "url": { "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "name": { + "type": "string" } }, "required": [ @@ -550272,9 +551886,6 @@ "url", "name" ] - }, - "sha": { - "type": "string" } }, "required": [ @@ -550282,165 +551893,61 @@ "sha", "repo" ] - }, - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ - "url", "id", "number", + "url", "head", "base" ] } }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" + "started_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] }, "status": { - "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", - "type": [ - "string", - "null" - ], + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", "enum": [ - "requested", + "queued", "in_progress", "completed", - "queued", - null, "pending" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL that points to the check suite API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "head_branch", - "head_sha", - "status", - "conclusion", - "url", - "before", - "after", - "pull_requests", - "app", - "created_at", - "updated_at", - "latest_check_runs_count", - "check_runs_url", - "head_commit" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", "examples": [ - "Octo Business" + "queued" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "url": { "type": "string", "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" + "https://api.github.com/repos/github/hello-world/check-runs/4" ] - }, - "avatar_url": { - "type": "string", - "format": "uri" } }, "required": [ "id", "node_id", + "head_sha", "name", - "slug", + "url", "html_url", - "created_at", - "updated_at", - "avatar_url" + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" ] }, "installation": { @@ -552036,6 +553543,16 @@ "updated_at" ] }, + "requested_action": { + "description": "The action requested by the user.", + "type": "object", + "properties": { + "identifier": { + "description": "The integrator reference of the action requested by the user.", + "type": "string" + } + } + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -552200,10 +553717,362 @@ }, "required": [ "action", - "check_suite", + "check_run", "repository", "sender" ] + }, + "examples": { + "default": { + "value": { + "action": "requested_action", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } + }, + "requested_action": { + "identifier": "lgtm|1234" + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Requested Action Event", + "description": "The check_run.requested_action webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } } } } @@ -552215,8 +554084,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check-suite", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -552225,13 +554095,13 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -552296,3326 +554166,2793 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert appeared_in_branch event", + "title": "Check Run Re-Requested Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "appeared_in_branch" - ] - }, - "alert": { - "description": "The code scanning alert involved in the event.", - "type": "object", - "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "dismissed_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": [ - "string", - "null" - ], - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances": { - "type": "array", - "items": { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - } - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": [ - "string", - "null" - ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "tool": { - "type": "object", - "properties": { - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "version" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" - ] - }, - "commit_oid": { - "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": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" + "rerequested" ] }, - "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" - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { + "app": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { - "key": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", "type": "string", "examples": [ - "mit" + "probot-owners" ] }, - "name": { + "node_id": { "type": "string", "examples": [ - "MIT License" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", "examples": [ - "https://api.github.com/licenses/mit" + "Probot Owners" ] }, - "spdx_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "MIT" + "The description of the app." ] }, - "node_id": { + "external_url": { "type": "string", + "format": "uri", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "https://example.com" ] }, "html_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" ] }, - "email": { - "type": [ - "string", - "null" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" ] }, - "login": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "octocat" + "2017-07-08T16:18:44-04:00" ] }, - "id": { + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", "type": "integer", "examples": [ - 1 + 5 ] }, - "node_id": { + "client_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "avatar_url": { + "client_secret": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, - "gravatar_id": { + "webhook_secret": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, - "url": { + "pem": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] - }, - "html_url": { - "type": "string", - "format": "uri", + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ], + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" + ] + }, + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", "examples": [ - "https://github.com/octocat" + 37 ] }, - "followers_url": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "probot-owners" ] }, - "following_url": { + "node_id": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "gists_url": { + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "Probot Owners" ] }, - "starred_url": { - "type": "string", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "The description of the app." ] }, - "subscriptions_url": { + "external_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://example.com" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/apps/super-ci" ] }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/repos" + "2017-07-08T16:18:44-04:00" ] }, - "events_url": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "2017-07-08T16:18:44-04:00" ] }, - "received_events_url": { + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "type": { + "client_secret": { "type": "string", "examples": [ - "User" + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, - "site_admin": { - "type": "boolean" + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] }, - "starred_at": { + "pem": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] - } - ] - }, - "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": { + "before": { "type": [ "string", "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, - "email": { + "conclusion": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], "examples": [ - "MDQ6VXNlcjE=" + "neutral" ] }, - "avatar_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "date-time" }, - "gravatar_id": { + "head_branch": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "master" ] }, - "events_url": { + "head_sha": { + "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, - "received_events_url": { - "type": "string", - "format": "uri", + "id": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/received_events" + 5 ] }, - "type": { + "node_id": { "type": "string", "examples": [ - "User" + "MDEwOkNoZWNrU3VpdGU1" ] }, - "site_admin": { - "type": "boolean" + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] + } + } }, - "git_refs_url": { - "type": "string", + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "2018-05-04T01:14:52Z" ] }, - "git_tags_url": { - "type": "string", + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "neutral" ] }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example" + ] + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" ] }, - "issue_comment_url": { + "details_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "https://example.com" ] }, - "issue_events_url": { + "external_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "42" ] }, - "issues_url": { + "head_sha": { + "description": "The SHA of the commit that is being checked.", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, - "keys_url": { + "html_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://github.com/github/hello-world/runs/4" ] }, - "labels_url": { - "type": "string", + "id": { + "description": "The id of the check.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 21 ] }, - "languages_url": { + "name": { + "description": "The name of the check.", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "test-coverage" ] }, - "merges_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "MDg6Q2hlY2tSdW40" ] }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" ] }, - "notifications_url": { + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "started_at": { "type": "string", + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "2018-05-04T01:14:52Z" ] }, - "pulls_url": { + "status": { + "description": "The phase of the lifecycle that the check is currently in.", "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "queued" ] }, - "releases_url": { + "url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 ] }, - "ssh_url": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "git@github.com:octocat/Hello-World.git" + "MDQ6VXNlcjU4MzIzMQ==" ] - }, - "stargazers_url": { + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "github" ] }, - "statuses_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + 1 ] }, - "subscribers_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "subscription_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/orgs/github" ] }, - "tags_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/orgs/github/repos" ] }, - "teams_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/orgs/github/events" ] }, - "trees_url": { + "hooks_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/orgs/github/hooks" ] }, - "clone_url": { + "issues_url": { "type": "string", "examples": [ - "https://github.com/octocat/Hello-World.git" + "https://api.github.com/orgs/github/issues" ] }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", + "members_url": { + "type": "string", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/orgs/github/members{/member}" ] }, - "hooks_url": { + "public_members_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "svn_url": { + "avatar_url": { "type": "string", - "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "homepage": { + "description": { "type": [ "string", "null" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", "examples": [ - 80 + "A great organization" ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + } + }, + "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": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", "type": "integer", "examples": [ - 108 + 42 ] }, - "default_branch": { - "description": "The default branch of the repository.", + "node_id": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "name": { + "description": "The name of the repository.", + "type": "string", "examples": [ - "2011-01-26T19:01:12Z" + "Team Environment" ] }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "full_name": { + "type": "string", "examples": [ - "2011-01-26T19:14:43Z" + "octocat/Hello-World" ] }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } ] }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, "login": { - "type": "string" + "type": "string", + "examples": [ + "octocat" + ] }, "id": { - "type": "integer" + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, "avatar_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, "followers_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, "following_url": { - "type": "string" + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, "gists_url": { - "type": "string" + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, "starred_url": { - "type": "string" + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, "subscriptions_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, "organizations_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, "events_url": { - "type": "string" + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { - "type": "string" + "type": "string", + "examples": [ + "User" + ] }, "site_admin": { "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } - } - }, - "private": { + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, - "html_url": { - "type": "string" + "pull": { + "type": "boolean" }, - "description": { - "type": "string" + "triage": { + "type": "boolean" }, - "fork": { + "push": { "type": "boolean" }, - "url": { - "type": "string" + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "archive_url": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "assignees_url": { - "type": "string" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "blobs_url": { - "type": "string" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "branches_url": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "collaborators_url": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "comments_url": { - "type": "string" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "commits_url": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "alert", - "ref", - "commit_oid", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "code-scanning-alert", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "code-scanning-alert-closed-by-user": { - "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-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": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "code_scanning_alert closed_by_user event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "closed_by_user" - ] - }, - "alert": { - "description": "The code scanning alert involved in the event.", - "type": "object", - "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", - "format": "date-time" - }, - "dismissed_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": [ - "string", - "null" - ], - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances": { - "type": "array", - "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - { - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "dismissed" - ] - } - }, - "required": [ - "state" - ] - } - ] - } - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": [ - "string", - "null" - ] - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": [ - "string", - "null" - ] - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": [ - "string", - "null" - ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "dismissed", - "fixed" - ] - }, - "tool": { - "type": "object", - "properties": { - "guid": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "version" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" - ] - }, - "commit_oid": { - "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": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "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" - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, "followers_url": { "type": "string", @@ -556895,461 +558232,1243 @@ } }, "required": [ - "action", - "alert", - "ref", - "commit_oid", + "check_run", "repository", "sender" ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "code-scanning-alert", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "code-scanning-alert-created": { - "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-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": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "code_scanning_alert created event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] - }, - "alert": { - "description": "The code scanning alert involved in the event.", - "type": "object", - "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": [ - "null" - ] - }, - "dismissed_by": { - "type": [ - "null" - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": [ - "null" - ] - }, - "fixed_at": { - "type": [ - "null" - ] - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" + }, + "examples": { + "default": { + "value": { + "action": "rerequested", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "completed", + "conclusion": "success", + "started_at": "2019-05-15T15:21:12Z", + "completed_at": "2019-05-15T15:21:45Z", + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" }, - "instances": { - "type": "array", - "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "completed", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } }, - { - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "open", - "dismissed" - ] - } - }, - "required": [ - "state" - ] + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } } - ] - } - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": [ - "object", - "null" + } ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Re-Requested Event", + "description": "The check_run.rerequested webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "check_suite completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/rest/reference/checks#suites).", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ] }, - "rule": { + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "help": { + "description": { "type": [ "string", "null" ] }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_group", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "projects_v2_item", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { "type": [ "string", "null" - ] + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" }, "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] }, "name": { + "description": "The name of the GitHub app", "type": "string" }, - "severity": { - "description": "The severity of the alert.", + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", "type": [ - "string", + "object", "null" ], - "enum": [ - "none", - "note", - "warning", - "error", - null + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, - "tags": { + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "format": "date-time" } }, "required": [ "id", - "severity", - "description" + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "state": { - "description": "State of a code scanning alert.", + "before": { + "type": [ + "string", + "null" + ] + }, + "check_runs_url": { "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "type": [ + "string", + "null" + ], "enum": [ - "open", - "dismissed" + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" ] }, - "tool": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", "type": [ - "object", + "string", "null" - ], + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", "properties": { - "guid": { - "type": [ - "string", - "null" + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" ] }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { "type": "string" }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" } }, "required": [ - "name", - "version" + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" ] }, - "updated_at": { + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", "type": [ "string", "null" + ], + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" ] }, + "updated_at": { + "type": "string", + "format": "date-time" + }, "url": { + "description": "URL that points to the check suite API resource.", "type": "string", "format": "uri" } }, "required": [ - "number", - "created_at", + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -557564,10 +559683,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -559201,9 +561316,7 @@ }, "required": [ "action", - "alert", - "ref", - "commit_oid", + "check_suite", "repository", "sender" ] @@ -559219,7 +561332,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code-scanning-alert", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -559228,13 +561341,13 @@ } } }, - "code-scanning-alert-fixed": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" }, "parameters": [ { @@ -559299,436 +561412,795 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert fixed event", + "title": "check_suite requested event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "fixed" + "requested" ] }, - "alert": { - "description": "The code scanning alert involved in the event.", + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/rest/reference/checks#suites).", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "after": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "dismissed_by": { - "title": "User", - "type": [ - "object", - "null" - ], + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "secret_scanning_alert_location", + "projects_v2_item", + "merge_group", + "repository_import" + ] + } }, - "followers_url": { - "type": "string", + "external_url": { + "type": [ + "string", + "null" + ], "format": "uri" }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, "html_url": { "type": "string", "format": "uri" }, "id": { - "type": "integer" - }, - "login": { - "type": "string" + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] }, "name": { + "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "login", - "id" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "before": { + "type": [ + "string", + "null" + ] + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", "type": [ "string", "null" ], "enum": [ - "false positive", - "won't fix", - "used in tests", - null + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" ] }, - "html_url": { - "description": "The GitHub URL of the alert resource.", + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "instances": { + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", "type": "array", "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "ref": { "type": "string" }, - "location": { + "repo": { + "title": "Repo Ref", "type": "object", "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { + "id": { "type": "integer" }, - "path": { + "name": { "type": "string" }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" + "url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "id", + "url", + "name" + ] }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", + "sha": { "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] } }, "required": [ "ref", - "analysis_key", - "environment", - "state" + "sha", + "repo" ] }, - { + "head": { "type": "object", "properties": { - "state": { - "type": "string", - "enum": [ - "fixed" + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" ] + }, + "sha": { + "type": "string" } }, "required": [ - "state" + "ref", + "sha", + "repo" ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" ] } }, - "instances_url": { - "type": "string", - "format": "uri" + "rerequestable": { + "type": "boolean" }, - "most_recent_instance": { - "title": "Alert Instance", + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", "type": [ - "object", + "string", "null" ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": [ - "string", - "null" - ] - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": [ - "string", - "null" - ] - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": [ - "string", - "null" - ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", "enum": [ - "fixed" + "requested", + "in_progress", + "completed", + "queued", + null ] }, - "tool": { - "type": "object", - "properties": { - "guid": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "version" - ] + "updated_at": { + "type": "string", + "format": "date-time" }, "url": { + "description": "URL that points to the check suite API resource.", "type": "string", "format": "uri" } }, "required": [ - "number", - "created_at", + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -559943,10 +562415,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -561580,9 +564048,7 @@ }, "required": [ "action", - "alert", - "ref", - "commit_oid", + "check_suite", "repository", "sender" ] @@ -561598,7 +564064,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code-scanning-alert", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -561607,13 +564073,13 @@ } } }, - "code-scanning-alert-reopened": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" }, "parameters": [ { @@ -561678,341 +564144,803 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened event", + "title": "check_suite rerequested event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "rerequested" ] }, - "alert": { - "description": "The code scanning alert involved in the event.", + "actions_meta": { "type": [ "object", "null" ], "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": [ - "string", - "null" - ] - }, - "dismissed_by": { - "type": [ - "object", - "null" - ] - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "rerun_info": { + "type": "object", + "properties": { + "plan_id": { + "type": "string" + }, + "job_ids": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/rest/reference/checks#suites).", + "type": "object", + "properties": { + "after": { "type": [ "string", "null" ] }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances": { - "type": "array", - "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - { - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "open" - ] - } - }, - "required": [ - "state" - ] - } - ] - } - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "classifications": { + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job" + ] } }, - "commit_sha": { + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", "type": "string" }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "node_id": { "type": "string" }, - "location": { - "type": "object", + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "end_column": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri" }, - "end_line": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "path": { + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "start_column": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" }, - "start_line": { + "id": { "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] }, - "message": { + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "text": { - "type": "string" + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] } } }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", + "slug": { + "description": "The slug name of the GitHub app", "type": "string" }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "ref", - "analysis_key", - "environment", - "state" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" + "before": { + "type": [ + "string", + "null" + ] }, - "rule": { + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", "type": "object", "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": [ - "string", - "null" + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" ] }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": [ - "string", - "null" + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" ] }, "id": { - "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, - "name": { + "message": { "type": "string" }, - "severity": { - "description": "The severity of the alert.", - "type": [ - "string", - "null" - ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] + "timestamp": { + "type": "string" }, - "tags": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "tree_id": { + "type": "string" } }, "required": [ "id", - "severity", - "description" + "tree_id", + "message", + "timestamp", + "author", + "committer" ] }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" }, - "tool": { - "type": "object", - "properties": { - "guid": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "version" + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null ] }, + "updated_at": { + "type": "string", + "format": "date-time" + }, "url": { + "description": "URL that points to the check suite API resource.", "type": "string", "format": "uri" } }, "required": [ - "number", - "created_at", + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" - ] - }, - "commit_oid": { - "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", - "null" + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" ] }, "enterprise": { @@ -562229,13 +565157,6 @@ "description" ] }, - "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", - "null" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -563869,9 +566790,7 @@ }, "required": [ "action", - "alert", - "ref", - "commit_oid", + "check_suite", "repository", "sender" ] @@ -563887,7 +566806,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code-scanning-alert", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -563896,11 +566815,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-appeared-in-branch": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, @@ -563967,13 +566886,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened_by_user event", + "title": "code_scanning_alert appeared_in_branch event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened_by_user" + "appeared_in_branch" ] }, "alert": { @@ -563988,18 +566907,118 @@ "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": [ + "string", "null" - ] + ], + "format": "date-time" }, "dismissed_by": { + "title": "User", "type": [ + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "type": [ + "string", "null" + ], + "enum": [ + "false positive", + "won't fix", + "used in tests", + null ] }, "html_url": { @@ -564010,94 +567029,76 @@ "instances": { "type": "array", "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } + "end_column": { + "type": "integer" }, - "commit_sha": { - "type": "string" + "end_line": { + "type": "integer" }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "path": { "type": "string" }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" + "start_column": { + "type": "integer" }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] + "start_line": { + "type": "integer" } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] + } }, - { + "message": { "type": "object", "properties": { - "state": { - "type": "string", - "enum": [ - "open" - ] + "text": { + "type": "string" } - }, - "required": [ - "state" + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" ] } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" ] } }, @@ -564215,6 +567216,7 @@ "type": "string", "enum": [ "open", + "dismissed", "fixed" ] }, @@ -566138,13 +569140,13 @@ } } }, - "commit-comment-created": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -566209,136 +569211,30 @@ "content": { "application/json": { "schema": { - "title": "commit_comment created event", + "title": "code_scanning_alert closed_by_user event", "type": "object", "properties": { "action": { - "description": "The action performed. Can be `created`.", "type": "string", "enum": [ - "created" + "closed_by_user" ] }, - "comment": { - "description": "The [commit comment](https://docs.github.com/rest/reference/repos#get-a-commit-comment) resource.", + "alert": { + "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "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" - }, - "html_url": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the commit comment.", - "type": "integer" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "description": "The node ID of the commit comment.", - "type": "string" - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": [ - "string", - "null" - ] - }, - "position": { - "description": "The line index in the diff to which the comment applies.", - "type": [ - "integer", - "null" - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "updated_at": { - "type": "string" + "format": "date-time" }, - "url": { + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": "string", - "format": "uri" + "format": "date-time" }, - "user": { + "dismissed_by": { "title": "User", "type": [ "object", @@ -566433,24 +569329,312 @@ "login", "id" ] + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "string", + "null" + ], + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + }, + "required": [ + "state" + ] + } + ] + } + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": [ + "string", + "null" + ] + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": [ + "string", + "null" + ], + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ + "number", + "created_at", "url", "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "created_at", - "updated_at", - "author_association", - "body" + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" ] }, + "commit_oid": { + "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -566665,6 +569849,10 @@ "description" ] }, + "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" + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -568298,7 +571486,9 @@ }, "required": [ "action", - "comment", + "alert", + "ref", + "commit_oid", "repository", "sender" ] @@ -568314,7 +571504,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit-comment", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -568323,12 +571513,13 @@ } } }, - "create": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are created at once.", - "operationId": "create", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -568393,16 +571584,362 @@ "content": { "application/json": { "schema": { - "title": "create event", + "title": "code_scanning_alert created event", "type": "object", "properties": { - "description": { - "description": "The repository's current description.", - "type": [ - "string", - "null" + "action": { + "type": "string", + "enum": [ + "created" ] }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": [ + "null" + ] + }, + "dismissed_by": { + "type": [ + "null" + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "null" + ] + }, + "fixed_at": { + "type": [ + "null" + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "open", + "dismissed" + ] + } + }, + "required": [ + "state" + ] + } + ] + } + }, + "instances_url": { + "type": "string" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": [ + "string", + "null" + ] + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": [ + "string", + "null" + ], + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed" + ] + }, + "tool": { + "type": [ + "object", + "null" + ], + "properties": { + "guid": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -568518,10 +572055,6 @@ "node_id" ] }, - "master_branch": { - "description": "The name of the repository's default branch (usually `main`).", - "type": "string" - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -568621,22 +572154,10 @@ "description" ] }, - "pusher_type": { - "description": "The pusher type for the event. Can be either `user` or a deploy key.", - "type": "string" - }, "ref": { - "description": "The [`git ref`](https://docs.github.com/rest/reference/git#get-a-reference) resource.", + "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" }, - "ref_type": { - "description": "The type of Git ref object created in the repository.", - "type": "string", - "enum": [ - "tag", - "branch" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -570269,11 +573790,10 @@ } }, "required": [ + "action", + "alert", "ref", - "ref_type", - "master_branch", - "description", - "pusher_type", + "commit_oid", "repository", "sender" ] @@ -570289,7 +573809,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -570298,12 +573818,13 @@ } } }, - "delete": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -570368,9 +573889,436 @@ "content": { "application/json": { "schema": { - "title": "delete event", + "title": "code_scanning_alert fixed event", "type": "object", "properties": { + "action": { + "type": "string", + "enum": [ + "fixed" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "string", + "null" + ], + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "fixed" + ] + } + }, + "required": [ + "state" + ] + } + ] + } + }, + "instances_url": { + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": [ + "string", + "null" + ] + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": [ + "string", + "null" + ], + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -570585,22 +574533,10 @@ "description" ] }, - "pusher_type": { - "description": "The pusher type for the event. Can be either `user` or a deploy key.", - "type": "string" - }, "ref": { - "description": "The [`git ref`](https://docs.github.com/rest/reference/git#get-a-reference) resource.", + "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" }, - "ref_type": { - "description": "The type of Git ref object deleted in the repository.", - "type": "string", - "enum": [ - "tag", - "branch" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -572233,9 +576169,10 @@ } }, "required": [ + "action", + "alert", "ref", - "ref_type", - "pusher_type", + "commit_oid", "repository", "sender" ] @@ -572251,7 +576188,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -572260,13 +576197,13 @@ } } }, - "dependabot-alert-created": { + "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -572331,665 +576268,432 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert created event", + "title": "code_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "reopened" ] }, "alert": { - "type": "object", - "description": "A Dependabot alert.", + "description": "The code scanning alert involved in the event.", + "type": [ + "object", + "null" + ], "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "dismissed", - "fixed", - "open" + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": [ + "string", + "null" ] }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } + "dismissed_by": { + "type": [ + "object", + "null" + ] }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], "properties": { - "package": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true + "end_column": { + "type": "integer" }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true + } }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, + "message": { + "type": "object", "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true + "text": { + "type": "string" } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true + } }, - "name": { + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true + "enum": [ + "open", + "dismissed", + "fixed" + ] } }, "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { "type": "object", - "description": "An advisory identifier.", - "readOnly": true, "properties": { - "type": { + "state": { "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, "enum": [ - "CVE", - "GHSA" + "open" ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true } }, "required": [ - "value", - "type" - ], - "additionalProperties": false + "state" + ] } + ] + } + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" }, - "references": { + "classifications": { "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" }, - "required": [ - "url" - ], - "additionalProperties": false + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } } }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } }, - "updated_at": { + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" }, - "withdrawn_at": { + "full_description": { + "type": "string" + }, + "help": { + "type": [ + "string", + "null" + ] + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", "type": [ "string", "null" ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } } }, "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", + "id", "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false + "description" + ] }, - "security_vulnerability": { + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "guid": { + "type": [ + "string", + "null" ] }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" }, - "first_patched_version": { + "version": { + "description": "The version of the tool used to detect the alert.", "type": [ - "object", + "string", "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false + ] } }, "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false + "name", + "version" + ] }, "url": { "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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", + "null" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, "html_url": { "type": "string", - "description": "The GitHub URL of the alert resource.", "format": "uri", - "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 + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "dismissed_at": { + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 ] }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "dismissed_comment": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { "type": [ "string", "null" ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "fixed_at": { + "updated_at": { "type": [ "string", "null" ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -573115,94 +576819,11 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "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", + "null" ] }, "repository": { @@ -574839,6 +578460,8 @@ "required": [ "action", "alert", + "ref", + "commit_oid", "repository", "sender" ] @@ -574854,7 +578477,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -574863,13 +578486,13 @@ } } }, - "dependabot-alert-dismissed": { + "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -574934,665 +578557,388 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert dismissed event", + "title": "code_scanning_alert reopened_by_user event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismissed" + "reopened_by_user" ] }, "alert": { + "description": "The code scanning alert involved in the event.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "dismissed", - "fixed", - "open" + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": [ + "null" ] }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } + "dismissed_by": { + "type": [ + "null" + ] }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "null" + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], "properties": { - "package": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true + "end_column": { + "type": "integer" }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true + } }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, + "message": { + "type": "object", "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true + "text": { + "type": "string" } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true + } }, - "name": { + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true + "enum": [ + "open", + "dismissed", + "fixed" + ] } }, "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { "type": "object", - "description": "An advisory identifier.", - "readOnly": true, "properties": { - "type": { + "state": { "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, "enum": [ - "CVE", - "GHSA" + "open" ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true } }, "required": [ - "value", - "type" - ], - "additionalProperties": false + "state" + ] } + ] + } + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" }, - "references": { + "classifications": { "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" }, - "required": [ - "url" - ], - "additionalProperties": false + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } } }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } }, - "updated_at": { + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" }, - "withdrawn_at": { + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", "type": [ "string", "null" ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "enum": [ + "none", + "note", + "warning", + "error", + null + ] } }, "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", + "id", "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false + "description" + ] }, - "security_vulnerability": { + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "fixed" + ] + }, + "tool": { "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" }, - "first_patched_version": { + "version": { + "description": "The version of the tool used to detect the alert.", "type": [ - "object", + "string", "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false + ] } }, "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false + "name", + "version" + ] }, "url": { "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, "html_url": { "type": "string", - "description": "The GitHub URL of the alert resource.", "format": "uri", - "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 + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "dismissed_at": { + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 ] }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "dismissed_comment": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { "type": [ "string", "null" ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "fixed_at": { + "updated_at": { "type": [ "string", "null" ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -575718,95 +579064,9 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + "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" }, "repository": { "title": "Repository", @@ -577442,6 +580702,8 @@ "required": [ "action", "alert", + "ref", + "commit_oid", "repository", "sender" ] @@ -577457,7 +580719,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -577466,13 +580728,13 @@ } } }, - "dependabot-alert-fixed": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" }, "parameters": [ { @@ -577537,665 +580799,337 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert fixed event", + "title": "commit_comment created event", "type": "object", "properties": { "action": { + "description": "The action performed. Can be `created`.", "type": "string", "enum": [ - "fixed" + "created" ] }, - "alert": { + "comment": { + "description": "The [commit comment](https://docs.github.com/rest/reference/repos#get-a-commit-comment) resource.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, "enum": [ - "dismissed", - "fixed", - "open" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "dependency": { + "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" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the commit comment.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the commit comment.", + "type": "string" + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": [ + "string", + "null" + ] + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "reactions": { + "title": "Reactions", "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false + "+1": { + "type": "integer" }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true + "-1": { + "type": "integer" }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] + "confused": { + "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" + ] }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "ghsa_id": { + "avatar_url": { "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true + "format": "uri" }, - "cve_id": { + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true + ] }, - "summary": { + "events_url": { "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 + "format": "uri-template" }, - "description": { + "followers_url": { "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true + "format": "uri" }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } + "following_url": { + "type": "string", + "format": "uri-template" }, - "severity": { + "gists_url": { "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "format": "uri-template" }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false + "gravatar_id": { + "type": "string" }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } + "html_url": { + "type": "string", + "format": "uri" }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } + "id": { + "type": "integer" }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } + "login": { + "type": "string" }, - "published_at": { + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "updated_at": { + "received_events_url": { "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false + "repos_url": { + "type": "string", + "format": "uri" }, - "severity": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, "enum": [ - "low", - "medium", - "high", - "critical" + "Bot", + "User", + "Organization" ] }, - "vulnerable_version_range": { + "url": { "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false + "format": "uri" } }, "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "id", + "node_id", + "user", + "position", + "line", + "path", + "commit_id", + "created_at", + "updated_at", + "author_association", + "body" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, "html_url": { "type": "string", - "description": "The GitHub URL of the alert resource.", "format": "uri", - "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 + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "dismissed_at": { + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 ] }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "dismissed_comment": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { "type": [ "string", "null" ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "fixed_at": { + "updated_at": { "type": [ "string", "null" ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -578321,96 +581255,6 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -580044,7 +582888,7 @@ }, "required": [ "action", - "alert", + "comment", "repository", "sender" ] @@ -580060,7 +582904,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "commit-comment", "supported-webhook-types": [ "repository", "organization", @@ -580069,13 +582913,12 @@ } } }, - "dependabot-alert-reintroduced": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are created at once.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -580140,665 +582983,105 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert reintroduced event", + "title": "create event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "reintroduced" + "description": { + "description": "The repository's current description.", + "type": [ + "string", + "null" ] }, - "alert": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "state": { + "html_url": { "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "dismissed", - "fixed", - "open" + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" ] }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" ], - "additionalProperties": false + "format": "uri" }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "html_url": { + "node_id": { "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "created_at": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "examples": [ + "Octo Business" + ] }, - "updated_at": { + "slug": { + "description": "The slug url identifier for the enterprise.", "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 + "examples": [ + "octo-business" + ] }, - "dismissed_at": { + "created_at": { "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "2019-01-26T19:01:12Z" ] }, - "dismissed_reason": { + "updated_at": { "type": [ "string", "null" ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -580825,6 +583108,10 @@ "node_id" ] }, + "master_branch": { + "description": "The name of the repository's default branch (usually `main`).", + "type": "string" + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -580924,94 +583211,20 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "pusher_type": { + "description": "The pusher type for the event. Can be either `user` or a deploy key.", + "type": "string" + }, + "ref": { + "description": "The [`git ref`](https://docs.github.com/rest/reference/git#get-a-reference) resource.", + "type": "string" + }, + "ref_type": { + "description": "The type of Git ref object created in the repository.", + "type": "string", + "enum": [ + "tag", + "branch" ] }, "repository": { @@ -582646,8 +584859,11 @@ } }, "required": [ - "action", - "alert", + "ref", + "ref_type", + "master_branch", + "description", + "pusher_type", "repository", "sender" ] @@ -582663,7 +584879,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "create", "supported-webhook-types": [ "repository", "organization", @@ -582672,13 +584888,12 @@ } } }, - "dependabot-alert-reopened": { + "delete": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when a Git branch or tag is deleted.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -582743,665 +584958,98 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert reopened event", + "title": "delete event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "reopened" - ] - }, - "alert": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "state": { + "html_url": { "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "dismissed", - "fixed", - "open" + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" ] }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" ], - "additionalProperties": false + "format": "uri" }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "html_url": { + "node_id": { "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "created_at": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "examples": [ + "Octo Business" + ] }, - "updated_at": { + "slug": { + "description": "The slug url identifier for the enterprise.", "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 + "examples": [ + "octo-business" + ] }, - "dismissed_at": { + "created_at": { "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "2019-01-26T19:01:12Z" ] }, - "dismissed_reason": { + "updated_at": { "type": [ "string", "null" ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -583527,94 +585175,20 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "pusher_type": { + "description": "The pusher type for the event. Can be either `user` or a deploy key.", + "type": "string" + }, + "ref": { + "description": "The [`git ref`](https://docs.github.com/rest/reference/git#get-a-reference) resource.", + "type": "string" + }, + "ref_type": { + "description": "The type of Git ref object deleted in the repository.", + "type": "string", + "enum": [ + "tag", + "branch" ] }, "repository": { @@ -585249,8 +586823,9 @@ } }, "required": [ - "action", - "alert", + "ref", + "ref_type", + "pusher_type", "repository", "sender" ] @@ -585266,7 +586841,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -585275,13 +586850,13 @@ } } }, - "deploy-key-created": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -585346,7 +586921,7 @@ "content": { "application/json": { "schema": { - "title": "deploy_key created event", + "title": "Dependabot alert created event", "type": "object", "properties": { "action": { @@ -585355,95 +586930,656 @@ "created" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "alert": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "html_url": { + "state": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], - "format": "uri" + "additionalProperties": false }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "name": { - "description": "The name of the enterprise.", + "html_url": { "type": "string", - "examples": [ - "Octo Business" - ] + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "created_at": { "type": "string", - "examples": [ - "octo-business" - ] + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "created_at": { + "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 + }, + "dismissed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "updated_at": { + "dismissed_reason": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -585470,55 +587606,6 @@ "node_id" ] }, - "key": { - "description": "The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource.", - "type": "object", - "properties": { - "added_by": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "last_used": { - "type": [ - "string", - "null" - ] - }, - "read_only": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "verified": { - "type": "boolean" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -585618,6 +587705,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -587251,7 +589428,7 @@ }, "required": [ "action", - "key", + "alert", "repository", "sender" ] @@ -587267,7 +589444,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy-key", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -587276,13 +589453,13 @@ } } }, - "deploy-key-deleted": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -587347,104 +589524,665 @@ "content": { "application/json": { "schema": { - "title": "deploy_key deleted event", + "title": "Dependabot alert dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "dismissed" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "alert": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "html_url": { + "state": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], - "format": "uri" + "additionalProperties": false }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "name": { - "description": "The name of the enterprise.", + "html_url": { "type": "string", - "examples": [ - "Octo Business" - ] + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "created_at": { "type": "string", - "examples": [ - "octo-business" - ] + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "created_at": { + "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 + }, + "dismissed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "updated_at": { + "dismissed_reason": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -587471,55 +590209,6 @@ "node_id" ] }, - "key": { - "description": "The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource.", - "type": "object", - "properties": { - "added_by": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "last_used": { - "type": [ - "string", - "null" - ] - }, - "read_only": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "verified": { - "type": "boolean" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -587619,6 +590308,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -589252,7 +592031,7 @@ }, "required": [ "action", - "key", + "alert", "repository", "sender" ] @@ -589268,7 +592047,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy-key", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -589277,13 +592056,13 @@ } } }, - "deployment-created": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -589348,761 +592127,665 @@ "content": { "application/json": { "schema": { - "title": "deployment created event", + "title": "Dependabot alert fixed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "fixed" ] }, - "deployment": { - "title": "Deployment", - "description": "The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments).", + "alert": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "created_at": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "deleted": { - "type": "boolean" + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true }, - "email": { + "scope": { "type": [ "string", "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { "type": "string", - "format": "uri" + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "following_url": { - "type": "string", - "format": "uri-template" + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true }, - "gists_url": { + "summary": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 }, - "html_url": { + "description": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true }, - "node_id": { - "type": "string" + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } }, - "organizations_url": { + "severity": { "type": "string", - "format": "uri" + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, - "received_events_url": { - "type": "string", - "format": "uri" + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false }, - "repos_url": { - "type": "string", - "format": "uri" + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } }, - "site_admin": { - "type": "boolean" + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } }, - "subscriptions_url": { + "published_at": { "type": "string", - "format": "uri" + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "type": { + "updated_at": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "url": { - "type": "string", - "format": "uri" + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "environment": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - } - ] - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "workflow_job", - "pull_request_review_thread", - "merge_queue_entry", - "secret_scanning_alert_location", - "merge_group" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" ], - "format": "uri" + "additionalProperties": false }, - "html_url": { + "severity": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true }, - "owner": { - "title": "User", + "first_patched_version": { "type": [ "object", "null" ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { + "identifier": { "type": "string", - "format": "uri" + "description": "The package version that patches this vulnerability.", + "readOnly": true } }, "required": [ - "login", - "id" - ] + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "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 + }, + "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 + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" + "name": { + "type": [ + "string", + "null" ] }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "organization_plan": { + "login": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "octocat" ] }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "organization_secrets": { + "node_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "organization_self_hosted_runners": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "packages": { + "url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "pages": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "pull_requests": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "repository_hooks": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "repository_projects": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "secret_scanning_alerts": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "secrets": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "security_events": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "security_scanning_alert": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, - "single_file": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "statuses": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "team_discussions": { + "type": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "User" ] }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "workflows": { + "starred_at": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "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" + ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" ] }, - "website_url": { - "description": "The enterprise's website URL.", + "dismissed_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "created_at": { + "dismissed_comment": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 }, - "updated_at": { + "fixed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -590228,6 +592911,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -591857,937 +594630,11 @@ "type", "url" ] - }, - "workflow": { - "title": "Workflow", - "type": [ - "object", - "null" - ], - "properties": { - "badge_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "badge_url", - "created_at", - "html_url", - "id", - "name", - "node_id", - "path", - "state", - "updated_at", - "url" - ] - }, - "workflow_run": { - "title": "Deployment Workflow Run", - "type": [ - "object", - "null" - ], - "properties": { - "actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "artifacts_url": { - "type": "string" - }, - "cancel_url": { - "type": "string" - }, - "check_suite_id": { - "type": "integer" - }, - "check_suite_node_id": { - "type": "string" - }, - "check_suite_url": { - "type": "string" - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "display_title": { - "type": "string" - }, - "event": { - "type": "string" - }, - "head_branch": { - "type": "string" - }, - "head_commit": { - "type": [ - "null" - ] - }, - "head_repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "head_sha": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "jobs_url": { - "type": "string" - }, - "logs_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "previous_attempt_url": { - "type": [ - "null" - ] - }, - "pull_requests": { - "type": "array", - "items": { - "title": "Check Run Pull Request", - "type": "object", - "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "number", - "head", - "base" - ] - } - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "rerun_url": { - "type": "string" - }, - "run_attempt": { - "type": "integer" - }, - "run_number": { - "type": "integer" - }, - "run_started_at": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - "triggering_actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "workflow_id": { - "type": "integer" - }, - "workflow_url": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_branch", - "head_sha", - "run_number", - "event", - "status", - "conclusion", - "workflow_id", - "check_suite_id", - "check_suite_node_id", - "url", - "html_url", - "path", - "pull_requests", - "created_at", - "updated_at", - "actor", - "run_attempt", - "run_started_at", - "display_title" - ] } }, "required": [ "action", - "deployment", - "workflow", - "workflow_run", + "alert", "repository", "sender" ] @@ -592803,7 +594650,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -592812,13 +594659,13 @@ } } }, - "deployment-status-created": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -592883,1497 +594730,665 @@ "content": { "application/json": { "schema": { - "title": "deployment_status created event", + "title": "Dependabot alert reintroduced event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "reintroduced" ] }, - "check_run": { - "type": [ - "object", - "null" - ], + "alert": { + "type": "object", + "description": "A Dependabot alert.", "properties": { - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - "skipped", - null - ] - }, - "details_url": { - "type": "string", - "format": "uri" - }, - "external_id": { - "type": "string" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The id of the check.", - "type": "integer" - }, - "name": { - "description": "The name of the check run.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "started_at": { - "type": "string", - "format": "date-time" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "status": { - "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`.", + "state": { "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "pending" + "dismissed", + "fixed", + "open" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_sha", - "external_id", - "url", - "html_url", - "details_url", - "status", - "conclusion", - "started_at", - "completed_at" - ] - }, - "deployment": { - "title": "Deployment", - "description": "The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "deleted": { - "type": "boolean" + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true }, - "email": { + "scope": { "type": [ "string", "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { "type": "string", - "format": "uri" + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "following_url": { - "type": "string", - "format": "uri-template" + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true }, - "gists_url": { + "summary": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 }, - "html_url": { + "description": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true }, - "node_id": { - "type": "string" + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } }, - "organizations_url": { + "severity": { "type": "string", - "format": "uri" + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, - "received_events_url": { - "type": "string", - "format": "uri" + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false }, - "repos_url": { - "type": "string", - "format": "uri" + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } }, - "site_admin": { - "type": "boolean" + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } }, - "subscriptions_url": { + "published_at": { "type": "string", - "format": "uri" + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "type": { + "updated_at": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "url": { - "type": "string", - "format": "uri" + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "environment": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], - "type": [ - "null", - "string", - "object" - ] + "additionalProperties": false }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "merge_queue_entry", - "workflow_job", - "pull_request_review_thread", - "secret_scanning_alert_location", - "merge_group" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" ], - "format": "uri" + "additionalProperties": false }, - "html_url": { + "severity": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true }, - "owner": { - "title": "User", + "first_patched_version": { "type": [ "object", "null" ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { + "identifier": { "type": "string", - "format": "uri" + "description": "The package version that patches this vulnerability.", + "readOnly": true } }, "required": [ - "login", - "id" - ] + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "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 + }, + "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 + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" + "name": { + "type": [ + "string", + "null" ] }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "organization_administration": { + "login": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "octocat" ] }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "organization_packages": { + "node_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "organization_plan": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "organization_secrets": { + "url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "organization_self_hosted_runners": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "organization_user_blocking": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "packages": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "pages": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "pull_requests": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "repository_hooks": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "repository_projects": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "secret_scanning_alerts": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, - "secrets": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "security_events": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "security_scanning_alert": { + "type": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "User" ] }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "statuses": { + "starred_at": { "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/rest/reference/deployments#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.", - "type": "string" - }, - "target_url": { - "description": "The optional link added to the status.", - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "state", - "creator", - "description", - "environment", - "target_url", - "created_at", - "updated_at", - "deployment_url", - "repository_url" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", + "dismissed_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "created_at": { + "dismissed_comment": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 }, - "updated_at": { + "fixed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -594499,6 +595514,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -596128,938 +597233,11 @@ "type", "url" ] - }, - "workflow": { - "title": "Workflow", - "type": [ - "object", - "null" - ], - "properties": { - "badge_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "badge_url", - "created_at", - "html_url", - "id", - "name", - "node_id", - "path", - "state", - "updated_at", - "url" - ] - }, - "workflow_run": { - "title": "Deployment Workflow Run", - "type": [ - "object", - "null" - ], - "properties": { - "actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "artifacts_url": { - "type": "string" - }, - "cancel_url": { - "type": "string" - }, - "check_suite_id": { - "type": "integer" - }, - "check_suite_node_id": { - "type": "string" - }, - "check_suite_url": { - "type": "string" - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null, - "startup_failure" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "display_title": { - "type": "string" - }, - "event": { - "type": "string" - }, - "head_branch": { - "type": "string" - }, - "head_commit": { - "type": [ - "null" - ] - }, - "head_repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "head_sha": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "jobs_url": { - "type": "string" - }, - "logs_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "previous_attempt_url": { - "type": [ - "null" - ] - }, - "pull_requests": { - "type": "array", - "items": { - "title": "Check Run Pull Request", - "type": "object", - "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "number", - "head", - "base" - ] - } - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "rerun_url": { - "type": "string" - }, - "run_attempt": { - "type": "integer" - }, - "run_number": { - "type": "integer" - }, - "run_started_at": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - "triggering_actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "workflow_id": { - "type": "integer" - }, - "workflow_url": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_branch", - "head_sha", - "run_number", - "event", - "status", - "conclusion", - "workflow_id", - "check_suite_id", - "check_suite_node_id", - "url", - "html_url", - "path", - "pull_requests", - "created_at", - "updated_at", - "actor", - "triggering_actor", - "run_attempt", - "run_started_at", - "display_title" - ] } }, "required": [ "action", - "deployment_status", - "deployment", + "alert", "repository", "sender" ] @@ -597075,7 +597253,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment-status", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -597084,13 +597262,13 @@ } } }, - "discussion-answered": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -597155,519 +597333,462 @@ "content": { "application/json": { "schema": { - "title": "discussion answered event", + "title": "Dependabot alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "answered" + "reopened" ] }, - "answer": { + "alert": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "created_at": { + "state": { "type": "string", - "format": "date-time" - }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { - "type": [ - "null" + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" ] }, - "reactions": { - "title": "Reactions", + "dependency": { "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "url": { + "manifest_path": { "type": "string", - "format": "uri" + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" + } }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, "properties": { - "avatar_url": { + "ghsa_id": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "email": { + "cve_id": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true }, - "repos_url": { + "summary": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 }, - "starred_url": { + "description": { "type": "string", - "format": "uri-template" + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } }, - "type": { + "severity": { "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body" - ] - }, - "discussion": { - "allOf": [ - { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" + "low", + "medium", + "high", + "critical" ] }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true }, - "email": { + "vector_string": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true } }, "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" + "score", + "vector_string" + ], + "additionalProperties": false }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } }, - "slug": { - "type": "string" + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] + "required": [ + "value", + "type" + ], + "additionalProperties": false + } }, - "comments": { - "type": "integer" + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } }, - "created_at": { + "published_at": { "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "number": { - "type": "integer" + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "reactions": { - "title": "Reactions", + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - "url": { + "name": { "type": "string", - "format": "uri" + "description": "The unique package name within its ecosystem.", + "readOnly": true } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" + "ecosystem", + "name" + ], + "additionalProperties": false }, - "state": { + "severity": { "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, "enum": [ - "open", - "locked", - "converting", - "transferring" + "low", + "medium", + "high", + "critical" ] }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { + "vulnerable_version_range": { "type": "string", - "format": "date-time" + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true }, - "user": { - "title": "User", + "first_patched_version": { "type": [ "object", "null" ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, "properties": { - "avatar_url": { + "identifier": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "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 + }, + "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 + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -597675,494 +597796,202 @@ "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { + "login": { "type": "string", - "format": "uri" + "examples": [ + "octocat" + ] }, "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": "string", - "format": "date-time" - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { "avatar_url": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "email": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, "following_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, "gists_url": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "organizations_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "received_events_url": { + "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "starred_url": { + "events_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "examples": [ + "User" ] }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "answer_html_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "type": "string" - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean", - "enum": [ - true - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } } - }, - "required": [ - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by" - ] - } - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" ] }, - "website_url": { - "description": "The enterprise's website URL.", + "dismissed_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "created_at": { + "dismissed_comment": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 }, - "updated_at": { + "fixed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -598288,6 +598117,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -599921,8 +599840,7 @@ }, "required": [ "action", - "discussion", - "answer", + "alert", "repository", "sender" ] @@ -599938,7 +599856,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -599947,13 +599865,13 @@ } } }, - "discussion-category-changed": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" }, "parameters": [ { @@ -600018,471 +599936,13 @@ "content": { "application/json": { "schema": { - "title": "discussion category changed event", + "title": "deploy_key created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "category_changed" - ] - }, - "changes": { - "type": "object", - "properties": { - "category": { - "type": "object", - "properties": { - "from": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "category" - ] - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" + "created" ] }, "enterprise": { @@ -600600,6 +600060,55 @@ "node_id" ] }, + "key": { + "description": "The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource.", + "type": "object", + "properties": { + "added_by": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "last_used": { + "type": [ + "string", + "null" + ] + }, + "read_only": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "verified": { + "type": "boolean" + } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -602332,8 +601841,7 @@ }, "required": [ "action", - "changes", - "discussion", + "key", "repository", "sender" ] @@ -602349,7 +601857,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy-key", "supported-webhook-types": [ "repository", "organization", @@ -602358,13 +601866,13 @@ } } }, - "discussion-comment-created": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" }, "parameters": [ { @@ -602429,624 +601937,13 @@ "content": { "application/json": { "schema": { - "title": "discussion_comment created event", + "title": "deploy_key deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" - ] - }, - "comment": { - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { - "type": [ - "integer", - "null" - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body", - "reactions" - ] - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" + "deleted" ] }, "enterprise": { @@ -603164,6 +602061,55 @@ "node_id" ] }, + "key": { + "description": "The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource.", + "type": "object", + "properties": { + "added_by": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "last_used": { + "type": [ + "string", + "null" + ] + }, + "read_only": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "verified": { + "type": "boolean" + } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -604896,8 +603842,7 @@ }, "required": [ "action", - "comment", - "discussion", + "key", "repository", "sender" ] @@ -604913,7 +603858,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion-comment", + "subcategory": "deploy-key", "supported-webhook-types": [ "repository", "organization", @@ -604922,13 +603867,13 @@ } } }, - "discussion-comment-deleted": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -604993,116 +603938,24 @@ "content": { "application/json": { "schema": { - "title": "discussion_comment deleted event", + "title": "deployment created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, - "comment": { + "deployment": { + "title": "Deployment", + "description": "The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments).", "type": "object", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" - }, "created_at": { "type": "string" }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { - "type": [ - "integer", - "null" - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -605197,417 +604050,558 @@ "login", "id" ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body", - "reactions" - ] - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { + }, + "description": { "type": [ "string", "null" ] }, - "answer_chosen_at": { - "type": [ - "string", - "null" + "environment": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "original_environment": { + "type": "string" + }, + "payload": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } ] }, - "answer_chosen_by": { - "title": "User", + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ "object", "null" ], "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "workflow_job", + "pull_request_review_thread", + "merge_queue_entry", + "secret_scanning_alert_location", + "merge_group" + ] + } }, - "followers_url": { - "type": "string", + "external_url": { + "type": [ + "string", + "null" + ], "format": "uri" }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, "html_url": { "type": "string", "format": "uri" }, "id": { - "type": "integer" - }, - "login": { - "type": "string" + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] }, "name": { + "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } }, "slug": { + "description": "The slug name of the GitHub app", "type": "string" }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "id", - "repository_id", - "emoji", + "node_id", + "owner", "name", "description", + "external_url", + "html_url", "created_at", - "updated_at", - "slug", - "is_answerable" + "updated_at" ] }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { + "production_environment": { "type": "boolean" }, - "node_id": { + "ref": { "type": "string" }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { "type": "string" }, - "state": { + "statuses_url": { "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "format": "uri" }, - "timeline_url": { + "task": { "type": "string" }, - "title": { - "type": "string" + "transient_environment": { + "type": "boolean" }, "updated_at": { - "type": "string", - "format": "date-time" + "type": "string" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", + "url", "id", "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", "created_at", "updated_at", - "author_association", - "active_lock_reason", - "body" + "statuses_url", + "repository_url" ] }, "enterprise": { @@ -607453,236 +606447,71 @@ "type", "url" ] - } - }, - "required": [ - "action", - "comment", - "discussion", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion-comment", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-comment-edited": { - "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "discussion_comment edited event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" - ] - }, - "changes": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "body" - ] }, - "comment": { - "type": "object", + "workflow": { + "title": "Workflow", + "type": [ + "object", + "null" + ], "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "badge_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" + "format": "uri" }, "created_at": { - "type": "string" - }, - "discussion_id": { - "type": "integer" + "type": "string", + "format": "date-time" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "node_id": { + "name": { "type": "string" }, - "parent_id": { - "type": [ - "integer", - "null" - ] + "node_id": { + "type": "string" }, - "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" - ] + "path": { + "type": "string" }, - "repository_url": { + "state": { "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, - "user": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "badge_url", + "created_at", + "html_url", + "id", + "name", + "node_id", + "path", + "state", + "updated_at", + "url" + ] + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": [ + "object", + "null" + ], + "properties": { + "actor": { "title": "User", "type": [ "object", @@ -607777,41 +606606,637 @@ "login", "id" ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body", - "reactions" - ] - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { + }, + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { "type": [ "string", "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null ] }, - "answer_chosen_at": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "display_title": { + "type": "string" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { "type": [ - "string", "null" ] }, - "answer_chosen_by": { + "head_repository": { + "type": "object", + "properties": { + "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" + }, + "description": { + "type": [ + "null" + ] + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_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" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": [ + "null" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "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" + }, + "description": { + "type": [ + "null" + ] + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_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" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { "title": "User", "type": [ "object", @@ -607907,174 +607332,257 @@ "id" ] }, - "answer_html_url": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "deployment", + "workflow", + "workflow_run", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "deployment_status created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "check_run": { + "type": [ + "object", + "null" + ], + "properties": { + "completed_at": { "type": [ "string", "null" - ] - }, - "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" - ] + ], + "format": "date-time" }, - "body": { + "conclusion": { + "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", "type": [ "string", "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + "skipped", + null ] }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] + "details_url": { + "type": "string", + "format": "uri" }, - "comments": { - "type": "integer" + "external_id": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { + "description": "The id of the check.", "type": "integer" }, - "locked": { - "type": "boolean" + "name": { + "description": "The name of the check run.", + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" + "started_at": { + "type": "string", + "format": "date-time" }, - "state": { + "status": { + "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`.", "type": "string", "enum": [ - "open", - "locked", - "converting", - "transferring" + "queued", + "in_progress", + "completed", + "waiting", + "pending" ] }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { + "url": { "type": "string", - "format": "date-time" + "format": "uri" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_sha", + "external_id", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at" + ] + }, + "deployment": { + "title": "Deployment", + "description": "The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments).", + "type": "object", + "properties": { + "created_at": { + "type": "string" }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -608169,504 +607677,1678 @@ "login", "id" ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { + }, "description": { - "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" + "environment": { + "type": "string" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] + "original_environment": { + "type": "string" }, - "created_at": { - "type": [ - "string", - "null" + "payload": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { "type": [ + "null", "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "object" ] }, - "description": { + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_queue_entry", + "workflow_job", + "pull_request_review_thread", + "secret_scanning_alert_location", + "merge_group" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "key": { + "avatar_url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri" }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "deleted": { + "type": "boolean" }, - "url": { + "email": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, - "html_url": { + "url": { "type": "string", "format": "uri" } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "login", + "id" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" + "actions": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "email": { - "type": [ - "string", - "null" + "administration": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "login": { + "checks": { "type": "string", - "examples": [ - "octocat" + "enum": [ + "read", + "write" ] }, - "id": { - "type": "integer", - "examples": [ - 1 + "content_references": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "node_id": { + "contents": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "enum": [ + "read", + "write" ] }, - "avatar_url": { + "deployments": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "enum": [ + "read", + "write" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "discussions": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "url": { + "emails": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "enum": [ + "read", + "write" ] }, - "html_url": { + "environments": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "enum": [ + "read", + "write" ] }, - "followers_url": { + "issues": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "enum": [ + "read", + "write" ] }, - "following_url": { + "keys": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "enum": [ + "read", + "write" ] }, - "gists_url": { + "members": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "enum": [ + "read", + "write" ] }, - "starred_url": { + "metadata": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "read", + "write" ] }, - "subscriptions_url": { + "organization_administration": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "enum": [ + "read", + "write" ] }, - "organizations_url": { + "organization_hooks": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "read", + "write" ] }, - "repos_url": { + "organization_packages": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "enum": [ + "read", + "write" ] }, - "events_url": { + "organization_plan": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "enum": [ + "read", + "write" ] }, - "received_events_url": { + "organization_projects": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "enum": [ + "read", + "write" ] }, - "type": { + "organization_secrets": { "type": "string", - "examples": [ - "User" + "enum": [ + "read", + "write" ] }, - "site_admin": { - "type": "boolean" + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "starred_at": { + "organization_user_blocking": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/rest/reference/deployments#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.", + "type": "string" + }, + "target_url": { + "description": "The optional link added to the status.", + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "state", + "creator", + "description", + "environment", + "target_url", + "created_at", + "updated_at", + "deployment_url", + "repository_url" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, "forks": { "type": "integer" @@ -610036,589 +610718,282 @@ "type", "url" ] - } - }, - "required": [ - "action", - "changes", - "comment", - "discussion", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion-comment", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-created": { - "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "discussion created event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "created" + }, + "workflow": { + "title": "Workflow", + "type": [ + "object", + "null" + ], + "properties": { + "badge_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "badge_url", + "created_at", + "html_url", + "id", + "name", + "node_id", + "path", + "state", + "updated_at", + "url" ] }, - "discussion": { - "allOf": [ - { - "title": "Discussion", - "type": "object", + "workflow_run": { + "title": "Deployment Workflow Run", + "type": [ + "object", + "null" + ], + "properties": { + "actor": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "deleted": { + "type": "boolean" }, - "answer_html_url": { + "email": { "type": [ "string", "null" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "events_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": [ - "string", - "null" - ] + "format": "uri-template" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "comments": { - "type": "integer" + "following_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "gists_url": { "type": "string", - "format": "date-time" + "format": "uri-template" }, - "html_url": { + "gravatar_id": { "type": "string" }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "locked": { - "type": "boolean" + "login": { + "type": "string" }, - "node_id": { + "name": { "type": "string" }, - "number": { - "type": "integer" + "node_id": { + "type": "string" }, - "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" - ] + "organizations_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "format": "uri" }, - "timeline_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "title": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "updated_at": { + "subscriptions_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" + "login", + "id" ] }, - { + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "display_title": { + "type": "string" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { + "type": [ + "null" + ] + }, + "head_repository": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "null" - ] + "archive_url": { + "type": "string" }, - "answer_chosen_at": { - "type": [ - "null" - ] + "assignees_url": { + "type": "string" }, - "answer_chosen_by": { - "type": [ - "null" - ] + "blobs_url": { + "type": "string" }, - "answer_html_url": { - "type": [ - "string", - "null" - ] + "branches_url": { + "type": "string" }, - "author_association": { + "collaborators_url": { "type": "string" }, - "body": { + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { "type": [ - "string", "null" ] }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } + "downloads_url": { + "type": "string" }, - "comments": { - "type": "integer" + "events_url": { + "type": "string" }, - "created_at": { + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { "type": "string" }, "html_url": { @@ -610627,74 +611002,40 @@ "id": { "type": "integer" }, - "locked": { - "type": "boolean", - "enum": [ - false - ] + "issue_comment_url": { + "type": "string" }, - "node_id": { + "issue_events_url": { "type": "string" }, - "number": { - "type": "integer" + "issues_url": { + "type": "string" }, - "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" - } - } + "keys_url": { + "type": "string" }, - "repository_url": { + "labels_url": { "type": "string" }, - "state": { - "type": "string", - "enum": [ - "open", - "converting", - "transferring" - ] + "languages_url": { + "type": "string" }, - "timeline_url": { + "merges_url": { "type": "string" }, - "title": { + "milestones_url": { "type": "string" }, - "updated_at": { + "name": { "type": "string" }, - "user": { + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { "type": "object", "properties": { "avatar_url": { @@ -610752,11 +611093,1570 @@ "type": "string" } } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_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" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": [ + "null" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "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" + }, + "description": { + "type": [ + "null" + ] + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_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" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "deployment_status", + "deployment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment-status", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-answered": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "discussion answered event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "answered" + ] + }, + "answer": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "null" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "discussion": { + "allOf": [ + { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] } }, "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", "state", "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": "string", + "format": "date-time" + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean", + "enum": [ + true + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "category", "answer_html_url", "answer_chosen_at", "answer_chosen_by" @@ -612612,6 +614512,7 @@ "required": [ "action", "discussion", + "answer", "repository", "sender" ] @@ -612636,11 +614537,11 @@ } } }, - "discussion-deleted": { + "discussion-category-changed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -612707,13 +614608,76 @@ "content": { "application/json": { "schema": { - "title": "discussion deleted event", + "title": "discussion category changed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "category_changed" + ] + }, + "changes": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "category" ] }, "discussion": { @@ -614958,6 +616922,7 @@ }, "required": [ "action", + "changes", "discussion", "repository", "sender" @@ -614983,13 +616948,13 @@ } } }, - "discussion-edited": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" }, "parameters": [ { @@ -615054,41 +617019,227 @@ "content": { "application/json": { "schema": { - "title": "discussion edited event", + "title": "discussion_comment created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "created" ] }, - "changes": { + "comment": { "type": "object", "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "integer", + "null" + ] + }, + "reactions": { + "title": "Reactions", "type": "object", "properties": { - "from": { - "type": "string" + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "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": [ - "from" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "title": { - "type": "object", + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "from": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + "login", + "id" ] } - } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] }, "discussion": { "title": "Discussion", @@ -615224,7 +617375,10 @@ ] }, "body": { - "type": "string" + "type": [ + "string", + "null" + ] }, "category": { "type": "object", @@ -617332,6 +619486,7 @@ }, "required": [ "action", + "comment", "discussion", "repository", "sender" @@ -617348,7 +619503,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion-comment", "supported-webhook-types": [ "repository", "organization", @@ -617357,13 +619512,13 @@ } } }, - "discussion-labeled": { + "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" }, "parameters": [ { @@ -617428,32 +619583,245 @@ "content": { "application/json": { "schema": { - "title": "discussion labeled event", + "title": "discussion_comment deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "labeled" + "deleted" ] }, - "discussion": { - "title": "Discussion", + "comment": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" + "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" ] }, - "answer_chosen_at": { + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { "type": [ - "string", + "integer", "null" ] }, - "answer_chosen_by": { + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { "title": "User", "type": [ "object", @@ -617571,10 +619939,7 @@ ] }, "body": { - "type": [ - "string", - "null" - ] + "type": "string" }, "category": { "type": "object", @@ -617950,49 +620315,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -619725,8 +622047,8 @@ }, "required": [ "action", + "comment", "discussion", - "label", "repository", "sender" ] @@ -619742,7 +622064,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion-comment", "supported-webhook-types": [ "repository", "organization", @@ -619751,13 +622073,13 @@ } } }, - "discussion-locked": { + "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" }, "parameters": [ { @@ -619822,619 +622144,643 @@ "content": { "application/json": { "schema": { - "title": "discussion locked event", + "title": "discussion_comment edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "locked" + "edited" ] }, - "discussion": { - "allOf": [ - { - "title": "Discussion", + "changes": { + "type": "object", + "properties": { + "body": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "body" + ] + }, + "comment": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "integer", + "null" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "answer_chosen_at": { + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, - "answer_html_url": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "events_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" + "format": "uri-template" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "comments": { - "type": "integer" + "following_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "gists_url": { "type": "string", - "format": "date-time" + "format": "uri-template" }, - "html_url": { + "gravatar_id": { "type": "string" }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "locked": { - "type": "boolean" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "received_events_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "state": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string", "enum": [ - "open", - "locked", - "converting", - "transferring" + "Bot", + "User", + "Organization" ] }, - "timeline_url": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { "type": "string" }, - "title": { + "emoji": { "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "id": { + "type": "integer" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", + "repository_id", + "emoji", + "name", + "description", "created_at", "updated_at", - "author_association", - "active_lock_reason", - "body" + "slug", + "is_answerable" ] }, - { + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", "type": "object", "properties": { - "active_lock_reason": { - "type": "string" + "+1": { + "type": "integer" }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] + "-1": { + "type": "integer" }, - "answer_chosen_by": { - "type": [ - "object", - "null" - ] + "confused": { + "type": "integer" }, - "answer_html_url": { + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "author_association": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "body": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } + "following_url": { + "type": "string", + "format": "uri-template" }, - "comments": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "locked": { - "type": "boolean", - "enum": [ - true - ] + "login": { + "type": "string" }, - "node_id": { + "name": { "type": "string" }, - "number": { - "type": "integer" + "node_id": { + "type": "string" }, - "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" - } - } + "organizations_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "locked" - ] + "format": "uri" }, - "timeline_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "title": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "updated_at": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "state", - "locked" + "login", + "id" ] } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" ] }, "enterprise": { @@ -622284,6 +624630,8 @@ }, "required": [ "action", + "changes", + "comment", "discussion", "repository", "sender" @@ -622300,7 +624648,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion-comment", "supported-webhook-types": [ "repository", "organization", @@ -622309,11 +624657,11 @@ } } }, - "discussion-pinned": { + "discussion-created": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -622380,408 +624728,630 @@ "content": { "application/json": { "schema": { - "title": "discussion pinned event", + "title": "discussion created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pinned" + "created" ] }, "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], + "allOf": [ + { + "title": "Discussion", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "deleted": { - "type": "boolean" + "answer_chosen_at": { + "type": [ + "string", + "null" + ] }, - "email": { + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { "type": [ "string", "null" ] }, - "events_url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri-template" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "body": { + "type": [ + "string", + "null" + ] }, - "following_url": { - "type": "string", - "format": "uri-template" + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] }, - "gists_url": { - "type": "string", - "format": "uri-template" + "comments": { + "type": "integer" }, - "gravatar_id": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "locked": { + "type": "boolean" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "number": { + "type": "integer" }, - "starred_url": { - "type": "string", - "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": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "repository_url": { + "type": "string" }, - "type": { + "state": { "type": "string", "enum": [ - "Bot", - "User", - "Organization" + "open", + "locked", + "converting", + "transferring" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { + "timeline_url": { "type": "string" }, - "repository_id": { - "type": "integer" - }, - "slug": { + "title": { "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] } }, "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", "id", - "repository_id", - "emoji", - "name", - "description", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", "created_at", "updated_at", - "slug", - "is_answerable" + "author_association", + "active_lock_reason", + "body" ] }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "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" + "active_lock_reason": { + "type": [ + "null" + ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "answer_chosen_at": { + "type": [ + "null" + ] }, - "deleted": { - "type": "boolean" + "answer_chosen_by": { + "type": [ + "null" + ] }, - "email": { + "answer_html_url": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "author_association": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "body": { + "type": [ + "string", + "null" + ] }, - "following_url": { - "type": "string", - "format": "uri-template" + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } }, - "gists_url": { - "type": "string", - "format": "uri-template" + "comments": { + "type": "integer" }, - "gravatar_id": { + "created_at": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "locked": { + "type": "boolean", + "enum": [ + false + ] }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "number": { + "type": "integer" }, - "starred_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "repository_url": { + "type": "string" }, - "type": { + "state": { "type": "string", "enum": [ - "Bot", - "User", - "Organization" + "open", + "converting", + "transferring" ] }, - "url": { - "type": "string", - "format": "uri" + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" + "state", + "locked", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by" ] } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" ] }, "enterprise": { @@ -624656,11 +627226,11 @@ } } }, - "discussion-transferred": { + "discussion-deleted": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -624727,1037 +627297,13 @@ "content": { "application/json": { "schema": { - "title": "discussion transferred event", + "title": "discussion deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" - ] - }, - "changes": { - "type": "object", - "properties": { - "new_discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - "new_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" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "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" - ] - } - }, - "required": [ - "new_discussion", - "new_repository" + "deleted" ] }, "discussion": { @@ -628002,7 +629548,6 @@ }, "required": [ "action", - "changes", "discussion", "repository", "sender" @@ -628028,11 +629573,11 @@ } } }, - "discussion-unanswered": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -628099,742 +629644,160 @@ "content": { "application/json": { "schema": { - "title": "discussion unanswered event", + "title": "discussion edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unanswered" + "edited" ] }, - "discussion": { - "allOf": [ - { - "title": "Discussion", + "changes": { + "type": "object", + "properties": { + "body": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { + "from": { "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" + "from" ] }, - { + "title": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "null" - ] + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "answer_chosen_by": { - "type": [ - "null" - ] + "deleted": { + "type": "boolean" }, - "answer_html_url": { + "email": { "type": [ "string", "null" ] }, - "author_association": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "body": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean", - "enum": [ - true - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "is_answerable" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "comments": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "locked": { - "type": "boolean" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "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" - } - } + "received_events_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "state": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "timeline_url": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "title": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "updated_at": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by" - ] - } - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "login", + "id" ] }, - "updated_at": { + "answer_html_url": { "type": [ "string", "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" ] }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "old_answer": { - "type": "object", - "properties": { "author_association": { "title": "AuthorAssociation", "description": "How the author is associated with the repository.", @@ -628853,29 +629816,74 @@ "body": { "type": "string" }, - "child_comment_count": { + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, - "discussion_id": { - "type": "integer" - }, "html_url": { "type": "string" }, "id": { "type": "integer" }, + "locked": { + "type": "boolean" + }, "node_id": { "type": "string" }, - "parent_id": { - "type": [ - "null" - ] + "number": { + "type": "integer" }, "reactions": { "title": "Reactions", @@ -628929,6 +629937,21 @@ "repository_url": { "type": "string" }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time" @@ -629031,20 +630054,142 @@ } }, "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", "id", "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", + "number", + "title", "user", + "state", + "locked", + "comments", "created_at", "updated_at", + "author_association", + "active_lock_reason", "body" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -630778,8 +631923,8 @@ "required": [ "action", "discussion", - "old_answer", - "repository" + "repository", + "sender" ] } } @@ -630802,11 +631947,11 @@ } } }, - "discussion-unlabeled": { + "discussion-labeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -630873,13 +632018,13 @@ "content": { "application/json": { "schema": { - "title": "discussion unlabeled event", + "title": "discussion labeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "labeled" ] }, "discussion": { @@ -631016,7 +632161,10 @@ ] }, "body": { - "type": "string" + "type": [ + "string", + "null" + ] }, "category": { "type": "object", @@ -633193,11 +634341,11 @@ } } }, - "discussion-unlocked": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -633264,13 +634412,13 @@ "content": { "application/json": { "schema": { - "title": "discussion unlocked event", + "title": "discussion locked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "locked" ] }, "discussion": { @@ -633674,22 +634822,23 @@ "type": "object", "properties": { "active_lock_reason": { - "type": [ - "null" - ] + "type": "string" }, "answer_chosen_at": { "type": [ + "string", "null" ] }, "answer_chosen_by": { "type": [ + "object", "null" ] }, "answer_html_url": { "type": [ + "string", "null" ] }, @@ -633749,7 +634898,7 @@ "locked": { "type": "boolean", "enum": [ - false + true ] }, "node_id": { @@ -633799,7 +634948,7 @@ "state": { "type": "string", "enum": [ - "open" + "locked" ] }, "timeline_url": { @@ -635750,11 +636899,11 @@ } } }, - "discussion-unpinned": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -635821,13 +636970,13 @@ "content": { "application/json": { "schema": { - "title": "discussion unpinned event", + "title": "discussion pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpinned" + "pinned" ] }, "discussion": { @@ -638097,12 +639246,13 @@ } } }, - "fork": { + "discussion-transferred": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/rest/repos/forks)\" 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.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -638167,406 +639317,721 @@ "content": { "application/json": { "schema": { - "title": "fork event", - "description": "A user forks a repository.", + "title": "discussion transferred event", "type": "object", "properties": { - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "action": { + "type": "string", + "enum": [ + "transferred" ] }, - "forkee": { - "description": "The created [`repository`](https://docs.github.com/rest/reference/repos#get-a-repository) resource.", - "allOf": [ - { - "title": "Repository", - "description": "A git repository", + "changes": { + "type": "object", + "properties": { + "new_discussion": { + "title": "Discussion", "type": "object", "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "homepage": { + "active_lock_reason": { "type": [ "string", "null" ] }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "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": { + "answer_chosen_at": { "type": [ "string", "null" ] }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + "new_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" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -638865,6 +640330,7 @@ "has_downloads", "has_wiki", "has_pages", + "has_discussions", "forks_count", "mirror_url", "archived", @@ -638877,323 +640343,496 @@ "topics", "visibility" ] + } + }, + "required": [ + "new_discussion", + "new_repository" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - { - "type": "object", + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "allow_forking": { - "type": "boolean" - }, - "archive_url": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri" }, - "archived": { + "deleted": { "type": "boolean" }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "clone_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" - }, - "created_at": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "description": { + "email": { "type": [ "string", "null" ] }, - "disabled": { - "type": "boolean" - }, - "downloads_url": { - "type": "string" - }, "events_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, - "fork": { - "type": "boolean", - "enum": [ - true - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "forks": { - "type": "integer" + "following_url": { + "type": "string", + "format": "uri-template" }, - "forks_count": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "forks_url": { + "gravatar_id": { "type": "string" }, - "full_name": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "git_commits_url": { - "type": "string" + "id": { + "type": "integer" }, - "git_refs_url": { + "login": { "type": "string" }, - "git_tags_url": { + "name": { "type": "string" }, - "git_url": { + "node_id": { "type": "string" }, - "has_downloads": { - "type": "boolean" + "organizations_url": { + "type": "string", + "format": "uri" }, - "has_issues": { - "type": "boolean" + "received_events_url": { + "type": "string", + "format": "uri" }, - "has_pages": { - "type": "boolean" + "repos_url": { + "type": "string", + "format": "uri" }, - "has_projects": { + "site_admin": { "type": "boolean" }, - "has_wiki": { - "type": "boolean" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "homepage": { - "type": [ - "string", - "null" + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, - "hooks_url": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { "type": "string" }, - "html_url": { + "emoji": { "type": "string" }, "id": { "type": "integer" }, - "is_template": { + "is_answerable": { "type": "boolean" }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { + "name": { "type": "string" }, - "issues_url": { + "node_id": { "type": "string" }, - "keys_url": { - "type": "string" + "repository_id": { + "type": "integer" }, - "labels_url": { + "slug": { "type": "string" }, - "language": { - "type": [ - "null" - ] - }, - "languages_url": { + "updated_at": { "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "license": { - "type": [ - "object", - "null" - ] - }, - "merges_url": { - "type": "string" + "-1": { + "type": "integer" }, - "milestones_url": { - "type": "string" + "confused": { + "type": "integer" }, - "mirror_url": { - "type": [ - "null" - ] + "eyes": { + "type": "integer" }, - "name": { - "type": "string" + "heart": { + "type": "integer" }, - "node_id": { - "type": "string" + "hooray": { + "type": "integer" }, - "notifications_url": { - "type": "string" + "laugh": { + "type": "integer" }, - "open_issues": { + "rocket": { "type": "integer" }, - "open_issues_count": { + "total_count": { "type": "integer" }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "private": { + "deleted": { "type": "boolean" }, - "public": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "pulls_url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "pushed_at": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "releases_url": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "size": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "ssh_url": { + "gravatar_id": { "type": "string" }, - "stargazers_count": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "stargazers_url": { + "login": { "type": "string" }, - "statuses_url": { + "name": { "type": "string" }, - "subscribers_url": { + "node_id": { "type": "string" }, - "subscription_url": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri" }, - "svn_url": { - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri" }, - "tags_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "teams_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "topics": { - "type": "array", - "items": { - "type": [ - "null" - ] - } + "starred_url": { + "type": "string", + "format": "uri-template" }, - "trees_url": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "updated_at": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" + "type": "string", + "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, "installation": { @@ -640952,7 +642591,9 @@ } }, "required": [ - "forkee", + "action", + "changes", + "discussion", "repository", "sender" ] @@ -640968,9 +642609,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "discussion", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -640978,13 +642618,13 @@ } } }, - "github-app-authorization-revoked": { + "discussion-unanswered": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about user-to-server requests, which require GitHub App authorization, see \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -641049,13 +642689,622 @@ "content": { "application/json": { "schema": { - "title": "github_app_authorization revoked event", + "title": "discussion unanswered event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "revoked" + "unanswered" + ] + }, + "discussion": { + "allOf": [ + { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "null" + ] + }, + "answer_chosen_by": { + "type": [ + "null" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean", + "enum": [ + true + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by" + ] + } ] }, "enterprise": { @@ -641173,96 +643422,309 @@ "node_id" ] }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "old_answer": { "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] + "body": { + "type": "string" }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] + "child_comment_count": { + "type": "integer" }, - "hooks_url": { + "created_at": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] + "format": "date-time" }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] + "discussion_id": { + "type": "integer" }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] + "html_url": { + "type": "string" }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] + "id": { + "type": "integer" }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "node_id": { + "type": "string" }, - "description": { + "parent_id": { "type": [ - "string", "null" - ], - "examples": [ - "A great organization" ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", "events_url", "hooks_url", "issues_url", @@ -642905,7 +645367,9 @@ }, "required": [ "action", - "sender" + "discussion", + "old_answer", + "repository" ] } } @@ -642919,19 +645383,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github-app-authorization", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "gollum": { + "discussion-unlabeled": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -642996,9 +645463,410 @@ "content": { "application/json": { "schema": { - "title": "gollum event", + "title": "discussion unlabeled event", "type": "object", "properties": { + "action": { + "type": "string", + "enum": [ + "unlabeled" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -643114,6 +645982,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -643213,54 +646124,6 @@ "description" ] }, - "pages": { - "description": "The pages that were updated.", - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "description": "The action that was performed on the page. Can be `created` or `edited`.", - "type": "string", - "enum": [ - "created", - "edited" - ] - }, - "html_url": { - "description": "Points to the HTML wiki page.", - "type": "string", - "format": "uri" - }, - "page_name": { - "description": "The name of the page.", - "type": "string" - }, - "sha": { - "description": "The latest commit SHA of the page.", - "type": "string" - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "title": { - "description": "The current page title.", - "type": "string" - } - }, - "required": [ - "page_name", - "title", - "summary", - "action", - "sha", - "html_url" - ] - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -644893,7 +647756,9 @@ } }, "required": [ - "pages", + "action", + "discussion", + "label", "repository", "sender" ] @@ -644909,7 +647774,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -644918,13 +647783,13 @@ } } }, - "installation-created": { + "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -644989,129 +647854,46 @@ "content": { "application/json": { "schema": { - "title": "installation created event", + "title": "discussion unlocked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "unlocked" ] }, - "installation": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "discussion": { + "allOf": [ + { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -645119,816 +647901,686 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, "type": { "type": "string", - "examples": [ - "User" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] + "format": "date-time" }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" + "description": { + "type": "string" + }, + "emoji": { + "type": "string" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "type": "integer" }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "is_answerable": { + "type": "boolean" }, "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] + "node_id": { + "type": "string" }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "repository_id": { + "type": "integer" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "slug": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": "string" } }, "required": [ "id", - "node_id", + "repository_id", + "emoji", "name", - "slug", - "html_url", + "description", "created_at", "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" + "slug", + "is_answerable" ] }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] + "comments": { + "type": "integer" }, - "issues": { + "created_at": { "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] + "html_url": { + "type": "string" }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] + "locked": { + "type": "boolean" }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "repository_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] + "number": { + "type": "integer" }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] + "repository_url": { + "type": "string" }, - "secret_scanning_alerts": { + "state": { "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ - "read", - "write" + "open", + "locked", + "converting", + "transferring" ] }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] + "timeline_url": { + "type": "string" }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] + "title": { + "type": "string" }, - "single_file": { + "updated_at": { "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "null" ] }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" + "answer_chosen_at": { + "type": [ + "null" ] }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" + "answer_chosen_by": { + "type": [ + "null" ] }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" + "answer_html_url": { + "type": [ + "null" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] + "author_association": { + "type": "string" }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] + "body": { + "type": "string" }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] + "comments": { + "type": "integer" }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] + "created_at": { + "type": "string" }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "html_url": { + "type": "string" }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "locked": { + "type": "boolean", "enum": [ - "read", - "write" + false ] }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" + "number": { + "type": "integer" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "reactions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] + "+1": { + "type": "integer" }, - "email": { - "type": [ - "string", - "null" - ] + "-1": { + "type": "integer" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "confused": { + "type": "integer" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "eyes": { + "type": "integer" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "heart": { + "type": "integer" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "hooray": { + "type": "integer" }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "events_url": { + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "type": "string" }, "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "type": "string" }, "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "gravatar_id": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "html_url": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "id": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "login": { + "type": "string" }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" }, "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "type": "string" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "repos_url": { + "type": "string" }, "site_admin": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "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" - ] + } } + }, + "required": [ + "state", + "locked" + ] + } + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" ] }, - "suspended_at": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "format": "date-time" + "format": "uri" }, - "contact_email": { + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", + "node_id", + "name", + "slug", "html_url", - "repositories_url", - "events", - "account", - "permissions", "created_at", "updated_at", - "suspended_by", - "suspended_at" + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" ] }, "organization": { @@ -646030,40 +648682,6 @@ "description" ] }, - "repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -647533,102 +650151,6 @@ "updated_at" ] }, - "requester": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -647793,7 +650315,8 @@ }, "required": [ "action", - "installation", + "discussion", + "repository", "sender" ] } @@ -647808,20 +650331,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-deleted": { + "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -647886,13 +650411,408 @@ "content": { "application/json": { "schema": { - "title": "installation deleted event", + "title": "discussion unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "unpinned" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" ] }, "enterprise": { @@ -647986,8 +650906,8 @@ ] }, "installation": { - "title": "Installation", - "description": "Installation", + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", "type": "object", "properties": { "id": { @@ -647997,1002 +650917,150 @@ 1 ] }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { "anyOf": [ { "type": "null" @@ -650430,11 +652498,6 @@ "updated_at" ] }, - "requester": { - "type": [ - "null" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -650599,7 +652662,8 @@ }, "required": [ "action", - "installation", + "discussion", + "repository", "sender" ] } @@ -650614,20 +652678,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-new-permissions-accepted": { + "fork": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/rest/repos/forks)\" 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.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -650692,15 +652757,10 @@ "content": { "application/json": { "schema": { - "title": "installation new_permissions_accepted event", + "title": "fork event", + "description": "A user forks a repository.", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "new_permissions_accepted" - ] - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -650791,659 +652851,324 @@ "avatar_url" ] }, - "installation": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", + "forkee": { + "description": "The created [`repository`](https://docs.github.com/rest/reference/repos#get-a-repository) resource.", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", "type": "object", - "description": "The permissions granted to the user-to-server access token.", "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] + "allow_update_branch": { + "type": "boolean" }, - "issues": { + "archive_url": { "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "metadata": { + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "packages": { + "blobs_url": { "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "pages": { + "branches_url": { "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "pull_requests": { + "clone_url": { "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "repository_announcement_banners": { + "collaborators_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "repository_hooks": { + "comments_url": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "repository_projects": { + "commits_url": { "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] + "format": "uri-template" }, - "secret_scanning_alerts": { + "compare_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "secrets": { + "contents_url": { "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "security_events": { + "contributors_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } ] }, - "single_file": { + "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", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" ] }, - "statuses": { + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "vulnerability_alerts": { + "events_url": { "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "workflows": { + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] + "format": "uri" }, - "members": { + "full_name": { + "type": "string" + }, + "git_commits_url": { "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_administration": { + "git_refs_url": { "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_custom_roles": { + "git_tags_url": { "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_announcement_banners": { + "git_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" + "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 + }, + "homepage": { + "type": [ + "string", + "null" ] }, - "organization_hooks": { + "hooks_url": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_plan": { + "html_url": { "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] + "format": "uri" }, - "organization_projects": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] + "format": "uri-template" }, - "organization_packages": { + "issue_events_url": { "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_secrets": { + "issues_url": { "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_self_hosted_runners": { + "keys_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_user_blocking": { + "labels_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" ] }, - "team_discussions": { + "languages_url": { "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" + "format": "uri" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "license": { + "title": "License", + "type": [ + "object", + "null" + ], "properties": { + "key": { + "type": "string" + }, "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { "type": [ "string", "null" - ] + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -651451,201 +653176,653 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, "type": { "type": "string", - "examples": [ - "User" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + { + "type": "object", + "properties": { + "allow_forking": { + "type": "boolean" + }, + "archive_url": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "clone_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" + }, + "created_at": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "type": "boolean" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean", + "enum": [ + true + ] + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "has_downloads": { + "type": "boolean" + }, + "has_issues": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "language": { + "type": [ + "null" + ] + }, + "languages_url": { + "type": "string" + }, + "license": { + "type": [ + "object", + "null" + ] + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "null" + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "topics": { + "type": "array", + "items": { + "type": [ + "null" + ] + } + }, + "trees_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + } + } + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { "type": "integer", "examples": [ 1 @@ -651733,40 +653910,6 @@ "description" ] }, - "repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -653236,11 +655379,6 @@ "updated_at" ] }, - "requester": { - "type": [ - "null" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -653404,8 +655542,8 @@ } }, "required": [ - "action", - "installation", + "forkee", + "repository", "sender" ] } @@ -653420,20 +655558,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "fork", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "installation-repositories-added": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about user-to-server requests, which require GitHub App authorization, see \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization" }, "parameters": [ { @@ -653498,13 +655639,13 @@ "content": { "application/json": { "schema": { - "title": "installation_repositories added event", + "title": "github_app_authorization revoked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "added" + "revoked" ] }, "enterprise": { @@ -653598,8 +655739,8 @@ ] }, "installation": { - "title": "Installation", - "description": "Installation", + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", "type": "object", "properties": { "id": { @@ -653609,835 +655750,17 @@ 1 ] }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "required": [ "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" + "node_id" ] }, "organization": { @@ -654539,67 +655862,6 @@ "description" ] }, - "repositories_added": { - "description": "An array of repository objects, which were added to the installation.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - } - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -656069,110 +657331,6 @@ "updated_at" ] }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "requester": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -656337,11 +657495,6 @@ }, "required": [ "action", - "installation", - "repository_selection", - "repositories_added", - "repositories_removed", - "requester", "sender" ] } @@ -656356,20 +657509,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation-repositories", + "subcategory": "github-app-authorization", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-removed": { + "gollum": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -656434,15 +657586,9 @@ "content": { "application/json": { "schema": { - "title": "installation_repositories removed event", + "title": "gollum event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "removed" - ] - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -656534,8 +657680,8 @@ ] }, "installation": { - "title": "Installation", - "description": "Installation", + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", "type": "object", "properties": { "id": { @@ -656545,835 +657691,17 @@ 1 ] }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "required": [ "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" + "node_id" ] }, "organization": { @@ -657475,71 +657803,51 @@ "description" ] }, - "repositories_added": { - "description": "An array of repository objects, which were added to the installation.", + "pages": { + "description": "The pages that were updated.", "type": "array", "items": { "type": "object", "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" + "action": { + "description": "The action that was performed on the page. Can be `created` or `edited`.", + "type": "string", + "enum": [ + "created", + "edited" + ] }, - "name": { - "description": "The name of the repository.", - "type": "string" + "html_url": { + "description": "Points to the HTML wiki page.", + "type": "string", + "format": "uri" }, - "node_id": { + "page_name": { + "description": "The name of the page.", "type": "string" }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { + "sha": { + "description": "The latest commit SHA of the page.", "type": "string" }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" + "summary": { + "type": [ + "string", + "null" + ] }, - "node_id": { + "title": { + "description": "The current page title.", "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" } }, "required": [ - "id", - "node_id", - "name", - "full_name", - "private" + "page_name", + "title", + "summary", + "action", + "sha", + "html_url" ] } }, @@ -659012,110 +659320,6 @@ "updated_at" ] }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "requester": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -659279,12 +659483,8 @@ } }, "required": [ - "action", - "installation", - "repository_selection", - "repositories_added", - "repositories_removed", - "requester", + "pages", + "repository", "sender" ] } @@ -659299,18 +659499,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation-repositories", + "subcategory": "gollum", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-suspend": { + "installation-created": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, @@ -659377,13 +659579,13 @@ "content": { "application/json": { "schema": { - "title": "installation suspend event", + "title": "installation created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "suspend" + "created" ] }, "enterprise": { @@ -661922,8 +662124,99 @@ ] }, "requester": { + "title": "User", "type": [ + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, "sender": { @@ -662112,13 +662405,13 @@ } } }, - "installation-target-renamed": { + "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-target" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -662183,157 +662476,14 @@ "content": { "application/json": { "schema": { + "title": "installation deleted event", "type": "object", "properties": { - "account": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "description": { - "type": [ - "null" - ] - }, - "events_url": { - "type": "string" - }, - "followers": { - "type": "integer" - }, - "followers_url": { - "type": "string" - }, - "following": { - "type": "integer" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_verified": { - "type": "boolean" - }, - "issues_url": { - "type": "string" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "public_gists": { - "type": "integer" - }, - "public_members_url": { - "type": "string" - }, - "public_repos": { - "type": "integer" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "slug": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "website_url": { - "type": [ - "null" - ] - } - }, - "required": [ - "id", - "node_id", - "avatar_url", - "html_url" - ] - }, "action": { - "type": "string" - }, - "changes": { - "type": "object", - "properties": { - "login": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "slug": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - } + "type": "string", + "enum": [ + "deleted" + ] }, "enterprise": { "title": "Enterprise", @@ -662426,8 +662576,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -662437,17 +662587,835 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { "type": "string", + "format": "uri", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ "id", - "node_id" + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" ] }, "organization": { @@ -662549,6 +663517,40 @@ "description" ] }, + "repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -664018,6 +665020,11 @@ "updated_at" ] }, + "requester": { + "type": [ + "null" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -664178,17 +665185,12 @@ "type", "url" ] - }, - "target_type": { - "type": "string" } }, "required": [ "action", - "target_type", - "account", - "changes", - "installation" + "installation", + "sender" ] } } @@ -664202,18 +665204,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation-target", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-unsuspend": { + "installation-new-permissions-accepted": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, @@ -664280,13 +665282,13 @@ "content": { "application/json": { "schema": { - "title": "installation unsuspend event", + "title": "installation new_permissions_accepted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unsuspend" + "new_permissions_accepted" ] }, "enterprise": { @@ -667015,13 +668017,13 @@ } } }, - "issue-comment-created": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" }, "parameters": [ { @@ -667086,558 +668088,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment created event", + "title": "installation_repositories added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" - ] - }, - "comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/rest/reference/issues#comments) itself.", - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "url", - "html_url", - "issue_url", - "id", - "node_id", - "user", - "created_at", - "updated_at", - "author_association", - "performed_via_github_app", - "body", - "reactions" + "added" ] }, "enterprise": { @@ -667731,8 +668188,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -667742,1794 +668199,8 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - }, - "required": [ - "labels", - "state", - "locked", - "assignee" - ] - } - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { + "account": { "anyOf": [ - { - "type": "null" - }, { "title": "Simple User", "description": "A GitHub user.", @@ -669690,107 +668361,1194 @@ "type", "url" ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } + ], + "type": [ + "null", + "object" ] }, - "forks": { + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", "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" + "target_type": { + "type": "string", + "examples": [ + "Organization" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user-to-server access token.", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" ] }, - "login": { + "administration": { "type": "string", - "examples": [ - "octocat" + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" ] }, - "id": { - "type": "integer", - "examples": [ - 1 + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" ] }, - "node_id": { + "contents": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" ] }, - "avatar_url": { + "deployments": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" ] }, - "url": { + "issues": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" ] }, - "html_url": { + "metadata": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" ] }, - "followers_url": { + "packages": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repositories_added": { + "description": "An array of repository objects, which were added to the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "repositories_removed": { + "description": "An array of repository objects, which were removed from the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + } + } + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, "following_url": { @@ -670901,6 +670659,110 @@ "updated_at" ] }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "requester": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -671065,9 +670927,11 @@ }, "required": [ "action", - "issue", - "comment", - "repository", + "installation", + "repository_selection", + "repositories_added", + "repositories_removed", + "requester", "sender" ] } @@ -671082,22 +670946,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-comment", + "subcategory": "installation-repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-deleted": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" }, "parameters": [ { @@ -671162,559 +671024,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "installation_repositories removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" - ] - }, - "comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/rest/reference/issues#comments) itself.", - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "required": [ - "url", - "html_url", - "issue_url", - "id", - "node_id", - "user", - "created_at", - "updated_at", - "author_association", - "performed_via_github_app", - "body", - "reactions" + "removed" ] }, "enterprise": { @@ -671808,8 +671124,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -671819,53 +671135,18 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -671873,1085 +671154,628 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "id": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "login": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "name": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, "site_admin": { "type": "boolean" }, - "starred_url": { + "starred_at": { "type": "string", - "format": "uri-template" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "subscriptions_url": { + "html_url": { "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], "format": "uri" }, - "type": { + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "url": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" } }, "required": [ - "login", - "id" + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "checks": { "type": "string", + "description": "The level of permission to grant the access token for checks on code.", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "read", + "write" ] }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] }, - "comments": { - "type": "integer" + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] }, - "comments_url": { + "issues": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] }, - "created_at": { + "metadata": { "type": "string", - "format": "date-time" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] }, - "draft": { - "type": "boolean" + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] }, - "events_url": { + "pages": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] }, - "html_url": { + "pull_requests": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] }, - "id": { - "type": "integer" + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] }, - "labels_url": { + "repository_projects": { "type": "string", - "format": "uri-template" + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] }, - "locked": { - "type": "boolean" + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" ] }, - "node_id": { - "type": "string" + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] }, - "number": { - "type": "integer" + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" ] }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] }, - "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" + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" ] }, - "repository_url": { + "members": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", + "organization_administration": { "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ - "open", - "closed" + "read", + "write" ] }, - "state_reason": { - "type": [ - "string", - "null" + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" ] }, - "timeline_url": { + "organization_announcement_banners": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] }, - "title": { - "description": "Title of the issue", - "type": "string" + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] }, - "updated_at": { + "organization_plan": { "type": "string", - "format": "date-time" + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] }, - "url": { - "description": "URL for the issue", + "organization_projects": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -672959,451 +671783,187 @@ "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { + "login": { "type": "string", - "format": "uri" + "examples": [ + "octocat" + ] }, "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { "avatar_url": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "email": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, "following_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, "gists_url": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "organizations_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "received_events_url": { + "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "starred_url": { + "events_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "User" ] }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } } - }, - "required": [ - "labels", - "state", - "locked", - "assignee" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" ] }, "organization": { @@ -673505,6 +672065,74 @@ "description" ] }, + "repositories_added": { + "description": "An array of repository objects, which were added to the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "repositories_removed": { + "description": "An array of repository objects, which were removed from the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -674974,6 +673602,110 @@ "updated_at" ] }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "requester": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -675138,9 +673870,11 @@ }, "required": [ "action", - "issue", - "comment", - "repository", + "installation", + "repository_selection", + "repositories_added", + "repositories_removed", + "requester", "sender" ] } @@ -675155,22 +673889,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-comment", + "subcategory": "installation-repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-edited": { + "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -675235,2791 +673967,1502 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "installation suspend event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "suspend" ] }, - "changes": { - "description": "The changes to the comment.", + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" ] - } - } - }, - "comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/rest/reference/issues#comments) itself.", - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + }, + "html_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" ] }, - "body": { - "description": "Contents of the issue comment", - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "created_at": { + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "format": "date-time" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "html_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri" + "examples": [ + "Octo Business" + ] }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer" + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] }, - "issue_url": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { + "account": { "anyOf": [ { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "probot-owners" + "octocat" ] }, - "node_id": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + 1 ] }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "name": { - "description": "The name of the GitHub app", + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "Probot Owners" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "The description of the app." + "41d064eb2195891e12d0413f63227ea7" ] }, - "external_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://github.com/octocat" ] }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/followers" ] }, - "updated_at": { + "following_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, + "starred_url": { + "type": "string", "examples": [ - "label", - "deployment" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", + "subscriptions_url": { + "type": "string", + "format": "uri", "examples": [ - 5 + "https://api.github.com/users/octocat/subscriptions" ] }, - "client_id": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat/orgs" ] }, - "client_secret": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + "https://api.github.com/users/octocat/repos" ] }, - "webhook_secret": { + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + 42 ] }, - "pem": { + "node_id": { "type": "string", "examples": [ - "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", "node_id", - "owner", "name", - "description", - "external_url", + "slug", "html_url", "created_at", "updated_at", - "permissions", - "events" + "avatar_url" ] } + ], + "type": [ + "null", + "object" ] }, - "reactions": { - "title": "Reactions", + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user-to-server access token.", "properties": { - "+1": { - "type": "integer" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] }, - "-1": { - "type": "integer" + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] }, - "confused": { - "type": "integer" + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] }, - "eyes": { - "type": "integer" + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] }, - "heart": { - "type": "integer" + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] }, - "hooray": { - "type": "integer" + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] }, - "laugh": { - "type": "integer" + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] }, - "rocket": { - "type": "integer" + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] }, - "total_count": { - "type": "integer" + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] }, - "url": { + "pages": { "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] }, - "deleted": { - "type": "boolean" + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] }, - "email": { - "type": [ - "string", - "null" + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" ] }, - "events_url": { + "repository_projects": { "type": "string", - "format": "uri-template" + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] }, - "followers_url": { + "secret_scanning_alerts": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] }, - "following_url": { + "secrets": { "type": "string", - "format": "uri-template" + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] }, - "gists_url": { + "security_events": { "type": "string", - "format": "uri-template" + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] }, - "gravatar_id": { - "type": "string" + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] }, - "html_url": { + "statuses": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] }, - "id": { - "type": "integer" + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] }, - "login": { - "type": "string" + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] }, - "name": { - "type": "string" + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] }, - "node_id": { - "type": "string" + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] }, - "organizations_url": { + "organization_custom_roles": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] }, - "received_events_url": { + "organization_announcement_banners": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] }, - "repos_url": { + "organization_hooks": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] }, - "site_admin": { - "type": "boolean" + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] }, - "starred_url": { + "organization_projects": { "type": "string", - "format": "uri-template" + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] }, - "subscriptions_url": { + "organization_packages": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] }, - "type": { + "organization_secrets": { "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "read", + "write" ] }, - "url": { + "organization_self_hosted_runners": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] } }, - "required": [ - "login", - "id" + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ - "url", - "html_url", - "issue_url", "id", - "node_id", - "user", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", "created_at", "updated_at", - "author_association", - "performed_via_github_app", - "body", - "reactions" + "suspended_by", + "suspended_at" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "login": { + "type": "string", + "examples": [ + "github" ] }, - "html_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/enterprises/octo-business" + "https://api.github.com/orgs/github" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", + "events_url": { + "type": "string", + "format": "uri", "examples": [ - 42 + "https://api.github.com/orgs/github/events" ] }, - "node_id": { + "hooks_url": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "https://api.github.com/orgs/github/hooks" ] }, - "name": { - "description": "The name of the enterprise.", + "issues_url": { "type": "string", "examples": [ - "Octo Business" + "https://api.github.com/orgs/github/issues" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "members_url": { "type": "string", "examples": [ - "octo-business" + "https://api.github.com/orgs/github/members{/member}" ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "public_members_url": { + "type": "string", "examples": [ - "2019-01-26T19:01:12Z" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "updated_at": { + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "A great organization" ] - }, - "avatar_url": { - "type": "string", - "format": "uri" } }, "required": [ + "login", + "url", "id", "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "The ID of the installation.", + "description": "Unique identifier of the repository", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + { + "title": "License Simple", + "description": "License Simple", + "type": "object", "properties": { - "avatar_url": { + "key": { "type": "string", - "format": "uri" + "examples": [ + "mit" + ] }, - "deleted": { - "type": "boolean" + "name": { + "type": "string", + "examples": [ + "MIT License" + ] }, - "email": { + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { "type": [ "string", "null" + ], + "examples": [ + "MIT" ] }, - "events_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "followers_url": { + "html_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "following_url": { + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "gists_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "id": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "login": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "name": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "organizations_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "received_events_url": { + "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "starred_url": { + "events_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "User" ] }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } + "pull": { + "type": "boolean" }, - "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" + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "body": { - "description": "Contents of the issue", + "email": { "type": [ "string", "null" ] }, - "closed_at": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "comments": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "comments_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "draft": { - "type": "boolean" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "events_url": { + "gists_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "id": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "labels_url": { + "repos_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "locked": { - "type": "boolean" + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "node_id": { - "type": "string" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - }, - "required": [ - "labels", - "state", - "locked", - "assignee" - ] - } - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "site_admin": { + "type": "boolean" }, "starred_at": { "type": "string", @@ -679068,6 +676511,11 @@ "updated_at" ] }, + "requester": { + "type": [ + "null" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -679232,10 +676680,7 @@ }, "required": [ "action", - "changes", - "issue", - "comment", - "repository", + "installation", "sender" ] } @@ -679250,22 +676695,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-assigned": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-target" }, "parameters": [ { @@ -679330,65 +676773,70 @@ "content": { "application/json": { "schema": { - "title": "issues assigned event", "type": "object", "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "assigned" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "account": { + "type": "object", "properties": { "avatar_url": { - "type": "string", - "format": "uri" + "type": "string" }, - "deleted": { - "type": "boolean" + "created_at": { + "type": "string" }, - "email": { + "description": { "type": [ - "string", "null" ] }, "events_url": { - "type": "string", - "format": "uri-template" + "type": "string" + }, + "followers": { + "type": "integer" }, "followers_url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "following": { + "type": "integer" }, "following_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gists_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gravatar_id": { "type": "string" }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "hooks_url": { + "type": "string" + }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, + "is_verified": { + "type": "boolean" + }, + "issues_url": { + "type": "string" + }, "login": { "type": "string" }, + "members_url": { + "type": "string" + }, "name": { "type": "string" }, @@ -679396,46 +676844,87 @@ "type": "string" }, "organizations_url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "public_gists": { + "type": "integer" + }, + "public_members_url": { + "type": "string" + }, + "public_repos": { + "type": "integer" }, "received_events_url": { - "type": "string", - "format": "uri" + "type": "string" }, "repos_url": { - "type": "string", - "format": "uri" + "type": "string" }, "site_admin": { "type": "boolean" }, + "slug": { + "type": "string" + }, "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" + }, + "updated_at": { + "type": "string" }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "website_url": { + "type": [ + "null" + ] } }, "required": [ - "login", - "id" + "id", + "node_id", + "avatar_url", + "html_url" ] }, + "action": { + "type": "string" + }, + "changes": { + "type": "object", + "properties": { + "login": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "slug": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -679551,1312 +677040,83 @@ "node_id" ] }, - "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "login": { + "type": "string", + "examples": [ + "github" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "node_id": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { + "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, "events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "html_url": { + "hooks_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "id": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "labels_url": { + "public_members_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "locked": { - "type": "boolean" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "description": { "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", + "string", "null" ], "examples": [ @@ -682508,13 +678768,17 @@ "type", "url" ] + }, + "target_type": { + "type": "string" } }, "required": [ "action", - "issue", - "repository", - "sender" + "target_type", + "account", + "changes", + "installation" ] } } @@ -682528,22 +678792,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation-target", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-closed": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/reference/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -682608,14 +678870,13 @@ "content": { "application/json": { "schema": { - "title": "issues closed event", + "title": "installation unsuspend event", "type": "object", "properties": { "action": { - "description": "The action that was performed.", "type": "string", "enum": [ - "closed" + "unsuspend" ] }, "enterprise": { @@ -682709,8 +678970,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -682720,53 +678981,18 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -682774,1410 +679000,816 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "id": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "login": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "name": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, "site_admin": { "type": "boolean" }, - "starred_url": { + "starred_at": { "type": "string", - "format": "uri-template" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "subscriptions_url": { + "html_url": { "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], "format": "uri" }, - "type": { + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "url": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" } }, "required": [ - "login", - "id" + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "checks": { "type": "string", + "description": "The level of permission to grant the access token for checks on code.", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "read", + "write" ] }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] }, - "comments": { - "type": "integer" + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] }, - "comments_url": { + "issues": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] }, - "created_at": { + "metadata": { "type": "string", - "format": "date-time" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] }, - "draft": { - "type": "boolean" + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] }, - "events_url": { + "pages": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] }, - "html_url": { + "pull_requests": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] }, - "id": { - "type": "integer" + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] }, - "labels_url": { + "repository_projects": { "type": "string", - "format": "uri-template" + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] }, - "locked": { - "type": "boolean" + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "closed_at": { + "name": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] }, - "created_at": { + "login": { "type": "string", - "format": "date-time" + "examples": [ + "octocat" + ] }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "description": { - "type": [ - "string", - "null" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "due_on": { + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "id": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "labels_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "node_id": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "open_issues": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "state": { - "description": "The state of the milestone.", + "organizations_url": { "type": "string", - "enum": [ - "open", - "closed" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "url", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" ] }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "closed", - "open" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - }, - "required": [ - "state", - "closed_at" + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" ] }, "organization": { @@ -684279,6 +679911,40 @@ "description" ] }, + "repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -685748,6 +681414,11 @@ "updated_at" ] }, + "requester": { + "type": [ + "null" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -685912,8 +681583,7 @@ }, "required": [ "action", - "issue", - "repository", + "installation", "sender" ] } @@ -685928,22 +681598,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-deleted": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" }, "parameters": [ { @@ -686008,149 +681676,449 @@ "content": { "application/json": { "schema": { - "title": "issues deleted event", + "title": "issue_comment created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/reference/issues#comments) itself.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "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" ] }, - "html_url": { + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] + "format": "date-time" }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], + "html_url": { + "type": "string", "format": "uri" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "description": "Unique identifier of the issue comment", + "type": "integer" }, - "node_id": { + "issue_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri" }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "node_id": { + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] + "format": "date-time" }, - "node_id": { - "description": "The global node ID of the installation.", + "url": { + "description": "URL for the issue comment", "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] + "format": "uri" }, - "assignee": { + "user": { "title": "User", "type": [ "object", @@ -686245,236 +682213,160 @@ "login", "id" ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, - "closed_at": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", "format": "uri" }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "events_url": { + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "html_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "examples": [ + "Octo Business" + ] }, - "labels_url": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", - "format": "uri-template" + "examples": [ + "octo-business" + ] }, - "locked": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "updated_at": { "type": [ - "object", + "string", "null" ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", "properties": { - "closed_at": { + "active_lock_reason": { "type": [ "string", "null" ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -686557,7 +682449,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -686570,188 +682463,1000 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { + "comments": { "type": "integer" }, - "labels_url": { + "comments_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "draft": { + "type": "boolean" }, - "open_issues": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "html_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "id": { + "type": "integer" }, - "updated_at": { - "type": "string", - "format": "date-time" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "url": { + "labels_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -686834,7 +683539,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -686846,513 +683552,375 @@ "login", "id" ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "deleted": { + "type": "boolean" }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "organization_projects": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_secrets": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_self_hosted_runners": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_user_blocking": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gravatar_id": { + "type": "string" }, - "pages": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] + "login": { + "type": "string" }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] + "name": { + "type": "string" }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "secrets": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_events": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_scanning_alert": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "statuses": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "team_discussions": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "vulnerability_alerts": { + "type": { "type": "string", "enum": [ - "read", - "write" + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "workflows": { + "url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] } }, - "slug": { - "description": "The slug name of the GitHub app", + "author_association": { "type": "string" }, - "updated_at": { + "body": { "type": [ "string", "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" + ] }, - "merged_at": { + "closed_at": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" + ] }, - "confused": { + "comments": { "type": "integer" }, - "eyes": { - "type": "integer" + "comments_url": { + "type": "string" }, - "heart": { - "type": "integer" + "created_at": { + "type": "string" }, - "hooray": { - "type": "integer" + "events_url": { + "type": "string" }, - "laugh": { - "type": "integer" + "html_url": { + "type": "string" }, - "rocket": { + "id": { "type": "integer" }, - "total_count": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "labels_url": { + "type": "string" }, - "deleted": { + "locked": { "type": "boolean" }, - "email": { + "milestone": { "type": [ - "string", + "object", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "node_id": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "following_url": { - "type": "string", - "format": "uri-template" + "performed_via_github_app": { + "type": [ + "object", + "null" + ] }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "gravatar_id": { + "repository_url": { "type": "string" }, - "html_url": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" + "enum": [ + "open", + "closed" + ] }, - "login": { + "timeline_url": { "type": "string" }, - "name": { + "title": { "type": "string" }, - "node_id": { + "updated_at": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" + "labels", + "state", + "locked", + "assignee" ] } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" ] }, "organization": { @@ -689088,6 +685656,7 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] @@ -689103,7 +685672,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-comment", "supported-webhook-types": [ "repository", "organization", @@ -689112,13 +685681,13 @@ } } }, - "issues-demilestoned": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" }, "parameters": [ { @@ -689183,188 +685752,735 @@ "content": { "application/json": { "schema": { - "title": "issues demilestoned event", + "title": "issue_comment deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "demilestoned" + "deleted" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/reference/issues#comments) itself.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "body": { + "description": "Contents of the issue comment", + "type": "string" }, - "name": { - "description": "The name of the enterprise.", + "created_at": { "type": "string", - "examples": [ - "Octo Business" - ] + "format": "date-time" }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "html_url": { "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "format": "uri" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer" }, - "avatar_url": { + "issue_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. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] }, "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", "properties": { - "avatar_url": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "format": "uri" + "examples": [ + "probot-owners" + ] }, - "deleted": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] }, - "email": { + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "The description of the app." ] }, - "events_url": { + "external_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://example.com" + ] }, - "followers_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] }, - "following_url": { + "created_at": { "type": "string", - "format": "uri-template" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] }, - "gists_url": { + "updated_at": { "type": "string", - "format": "uri-template" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] }, - "gravatar_id": { - "type": "string" + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -690153,8 +687269,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -690546,9 +687661,100 @@ ] }, "assignee": { + "title": "User", "type": [ "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, "assignees": { @@ -690596,9 +687802,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] } }, @@ -690609,196 +687852,9 @@ "type": "boolean" }, "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", "type": [ "object", "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" ] }, "node_id": { @@ -690852,7 +687908,12 @@ "type": "string" }, "state": { - "type": "string" + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] }, "timeline_url": { "type": "string" @@ -690927,199 +687988,12 @@ } }, "required": [ - "milestone" - ] - } - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" + "labels", + "state", + "locked", + "assignee" ] - }, - "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" ] }, "organization": { @@ -692855,6 +689729,7 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] @@ -692870,7 +689745,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-comment", "supported-webhook-types": [ "repository", "organization", @@ -692879,13 +689754,13 @@ } } }, - "issues-edited": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" }, "parameters": [ { @@ -692950,7 +689825,7 @@ "content": { "application/json": { "schema": { - "title": "issues edited event", + "title": "issue_comment edited event", "type": "object", "properties": { "action": { @@ -692960,7 +689835,7 @@ ] }, "changes": { - "description": "The changes to the issue.", + "description": "The changes to the comment.", "type": "object", "properties": { "body": { @@ -692974,155 +689849,443 @@ "required": [ "from" ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title.", - "type": "string" - } - }, - "required": [ - "from" - ] } } }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/reference/issues#comments) itself.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "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" ] }, - "html_url": { + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] + "format": "date-time" }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], + "html_url": { + "type": "string", "format": "uri" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "description": "Unique identifier of the issue comment", + "type": "integer" }, - "node_id": { + "issue_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri" }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "node_id": { + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] + "format": "date-time" }, - "node_id": { - "description": "The global node ID of the installation.", + "url": { + "description": "URL for the issue comment", "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] + "format": "uri" }, - "assignee": { + "user": { "title": "User", "type": [ "object", @@ -693218,237 +690381,160 @@ "login", "id" ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, - "closed_at": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", "format": "uri" }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "events_url": { + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "html_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "examples": [ + "Octo Business" + ] }, - "labels_url": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", - "format": "uri-template" + "examples": [ + "octo-business" + ] }, - "locked": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "updated_at": { "type": [ - "object", + "string", "null" ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", "properties": { - "closed_at": { + "active_lock_reason": { "type": [ "string", "null" ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -693545,190 +690631,999 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "labels_url": { + "draft": { + "type": "boolean" + }, + "events_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "number": { - "description": "The number of the milestone.", + "id": { "type": "integer" }, - "open_issues": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "state": { - "description": "The state of the milestone.", + "labels_url": { "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "format": "uri-template" }, - "updated_at": { - "type": "string", - "format": "date-time" + "locked": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -693811,7 +691706,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -693823,558 +691719,375 @@ "login", "id" ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "actions": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, - "checks": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "content_references": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "contents": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_user_blocking": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gravatar_id": { + "type": "string" }, - "pages": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] + "login": { + "type": "string" }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] + "name": { + "type": "string" }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "secrets": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_events": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_scanning_alert": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "statuses": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "team_discussions": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "vulnerability_alerts": { + "type": { "type": "string", "enum": [ - "read", - "write" + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "workflows": { + "url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] } }, - "slug": { - "description": "The slug name of the GitHub app", + "author_association": { "type": "string" }, - "updated_at": { + "body": { "type": [ "string", "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" + ] }, - "merged_at": { + "closed_at": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" + ] }, - "confused": { + "comments": { "type": "integer" }, - "eyes": { - "type": "integer" + "comments_url": { + "type": "string" }, - "heart": { - "type": "integer" + "created_at": { + "type": "string" }, - "hooray": { - "type": "integer" + "events_url": { + "type": "string" }, - "laugh": { - "type": "integer" + "html_url": { + "type": "string" }, - "rocket": { + "id": { "type": "integer" }, - "total_count": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "labels_url": { + "type": "string" }, - "deleted": { + "locked": { "type": "boolean" }, - "email": { + "milestone": { "type": [ - "string", + "object", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "node_id": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "following_url": { - "type": "string", - "format": "uri-template" + "performed_via_github_app": { + "type": [ + "object", + "null" + ] }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "gravatar_id": { + "repository_url": { "type": "string" }, - "html_url": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" + "enum": [ + "open", + "closed" + ] }, - "login": { + "timeline_url": { "type": "string" }, - "name": { + "title": { "type": "string" }, - "node_id": { + "updated_at": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" + "labels", + "state", + "locked", + "assignee" ] - }, - "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" ] }, "organization": { @@ -696111,6 +693824,7 @@ "action", "changes", "issue", + "comment", "repository", "sender" ] @@ -696126,7 +693840,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-comment", "supported-webhook-types": [ "repository", "organization", @@ -696135,11 +693849,11 @@ } } }, - "issues-labeled": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -696206,13 +693920,110 @@ "content": { "application/json": { "schema": { - "title": "issues labeled event", + "title": "issues assigned event", "type": "object", "properties": { "action": { + "description": "The action that was performed.", "type": "string", "enum": [ - "labeled" + "assigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -696923,8 +694734,8 @@ "watch", "workflow_dispatch", "workflow_run", - "pull_request_review_thread", - "reminder" + "reminder", + "pull_request_review_thread" ] } }, @@ -697559,49 +695370,6 @@ "reactions" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -699359,11 +697127,11 @@ } } }, - "issues-locked": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -699430,13 +697198,14 @@ "content": { "application/json": { "schema": { - "title": "issues locked event", + "title": "issues closed event", "type": "object", "properties": { "action": { + "description": "The action that was performed.", "type": "string", "enum": [ - "locked" + "closed" ] }, "enterprise": { @@ -699555,6 +697324,7 @@ ] }, "issue": { + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", "allOf": [ { "title": "Issue", @@ -699657,7 +697427,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -699755,7 +697526,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -699981,7 +697753,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -700146,8 +697919,9 @@ "watch", "workflow_dispatch", "workflow_run", + "security_and_analysis", "reminder", - "security_and_analysis" + "pull_request_review_thread" ] } }, @@ -700399,7 +698173,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -700742,7 +698517,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -700787,13 +698563,6 @@ "type": [ "string", "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null ] }, "assignee": { @@ -700857,10 +698626,7 @@ "type": "string" }, "locked": { - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "milestone": { "type": [ @@ -700919,7 +698685,11 @@ "type": "string" }, "state": { - "type": "string" + "type": "string", + "enum": [ + "closed", + "open" + ] }, "timeline_url": { "type": "string" @@ -700994,8 +698764,8 @@ } }, "required": [ - "locked", - "active_lock_reason" + "state", + "closed_at" ] } ] @@ -702757,11 +700527,11 @@ } } }, - "issues-milestoned": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -702828,13 +700598,13 @@ "content": { "application/json": { "schema": { - "title": "issues milestoned event", + "title": "issues deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "milestoned" + "deleted" ] }, "enterprise": { @@ -702953,26 +700723,348 @@ ] }, "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "Bot", + "User", + "Organization" ] }, - "assignee": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -703068,152 +701160,19 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + "description": { "type": [ "string", "null" ] }, - "closed_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time" }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, "html_url": { "type": "string", "format": "uri" @@ -703221,832 +701180,30 @@ "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, "labels_url": { "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] + "format": "uri" }, "node_id": { "type": "string" }, "number": { + "description": "The number of the milestone.", "type": "integer" }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ] }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, "title": { - "description": "Title of the issue", + "description": "The title of the milestone.", "type": "string" }, "updated_at": { @@ -704054,11 +701211,137 @@ "format": "date-time" }, "url": { - "description": "URL for the issue", "type": "string", "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "user": { + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -704153,445 +701436,395 @@ "login", "id" ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { + "actions": { "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "enum": [ + "read", + "write" ] }, - "description": { - "type": [ - "string", - "null" + "administration": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { + "checks": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "labels_url": { + "content_references": { "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "open_issues": { - "type": "integer" + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "state": { - "description": "The state of the milestone.", + "deployments": { "type": "string", "enum": [ - "open", - "closed" + "read", + "write" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "updated_at": { + "emails": { "type": "string", - "format": "date-time" + "enum": [ + "read", + "write" + ] }, - "url": { + "environments": { "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "-1": { - "type": "integer" + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "confused": { - "type": "integer" + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "eyes": { - "type": "integer" + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "heart": { - "type": "integer" + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "hooray": { - "type": "integer" + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "laugh": { - "type": "integer" + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "rocket": { - "type": "integer" + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "total_count": { - "type": "integer" + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "events_url": { - "type": "string" + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "followers_url": { - "type": "string" + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "following_url": { - "type": "string" + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "gists_url": { - "type": "string" + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "gravatar_id": { - "type": "string" + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "html_url": { - "type": "string" + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "id": { - "type": "integer" + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "login": { - "type": "string" + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "node_id": { - "type": "string" + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "organizations_url": { - "type": "string" + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "received_events_url": { - "type": "string" + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "repos_url": { - "type": "string" + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "site_admin": { - "type": "boolean" + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "starred_url": { - "type": "string" + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "subscriptions_url": { - "type": "string" + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "type": { - "type": "string" + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "url": { - "type": "string" + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] } } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "milestone" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] - } - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "timeline_url": { + "type": "string", + "format": "uri" }, - "created_at": { + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { "type": "string", "format": "date-time" }, - "creator": { + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -704674,8 +701907,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -704687,79 +701919,30 @@ "login", "id" ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ "url", - "html_url", + "repository_url", "labels_url", + "comments_url", + "events_url", + "html_url", "id", "node_id", "number", "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", + "user", + "assignees", + "milestone", + "comments", "created_at", "updated_at", - "due_on", - "closed_at" + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, "organization": { @@ -706495,7 +703678,6 @@ "required": [ "action", "issue", - "milestone", "repository", "sender" ] @@ -706520,11 +703702,11 @@ } } }, - "issues-opened": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -706591,25 +703773,136 @@ "content": { "application/json": { "schema": { - "title": "issues opened event", + "title": "issues demilestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "opened" + "demilestoned" ] }, - "changes": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "old_issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "description": { + "description": "A short description of the enterprise.", "type": [ - "object", + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", "null" ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", "properties": { "active_lock_reason": { "type": [ @@ -706707,7 +704000,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -706805,7 +704099,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -707031,7 +704326,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -707447,7 +704743,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -707790,7 +705087,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -707828,969 +705126,34 @@ "reactions" ] }, - "old_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 + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" + "assignee": { + "type": [ + "object", + "null" + ] }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "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" - } - }, - "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", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - } - }, - "required": [ - "old_issue", - "old_repository" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, "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" - ] + "type": "string" }, "body": { - "description": "Contents of the issue", "type": [ "string", "null" @@ -708800,30 +705163,22 @@ "type": [ "string", "null" - ], - "format": "date-time" + ] }, "comments": { "type": "integer" }, "comments_url": { - "type": "string", - "format": "uri" + "type": "string" }, "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" + "type": "string" }, "events_url": { - "type": "string", - "format": "uri" + "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" @@ -708831,52 +705186,14 @@ "labels": { "type": "array", "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" + "type": [ + "object", + "null" ] } }, "labels_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "locked": { "type": "boolean" @@ -709081,510 +705398,12 @@ "type": "integer" }, "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ "object", "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" ] }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, "reactions": { - "title": "Reactions", "type": "object", "properties": { "+1": { @@ -709615,100 +705434,51 @@ "type": "integer" }, "url": { - "type": "string", - "format": "uri" + "type": "string" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + } }, "repository_url": { - "type": "string", - "format": "uri" + "type": "string" }, "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] + "type": "string" }, "timeline_url": { - "type": "string", - "format": "uri" + "type": "string" }, "title": { - "description": "Title of the issue", "type": "string" }, "updated_at": { - "type": "string", - "format": "date-time" + "type": "string" }, "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" + "type": "string" }, "user": { - "title": "User", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] + "type": "string" }, "events_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri" + "type": "string" }, "following_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gists_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" @@ -709716,290 +705486,230 @@ "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" } - }, - "required": [ - "login", - "id" - ] + } } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "milestone" ] + } + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - { - "type": "object", + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } + "avatar_url": { + "type": "string", + "format": "uri" }, - "author_association": { - "type": "string" + "deleted": { + "type": "boolean" }, - "body": { + "email": { "type": [ "string", "null" ] }, - "closed_at": { - "type": [ - "string", - "null" - ] + "events_url": { + "type": "string", + "format": "uri-template" }, - "comments": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri" }, - "comments_url": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { - "type": "string" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "events_url": { + "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "labels_url": { + "login": { "type": "string" }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] + "received_events_url": { + "type": "string", + "format": "uri" }, - "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" - } - } + "repos_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "state": { + "starred_url": { "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "timeline_url": { - "type": "string" + "format": "uri-template" }, - "title": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "updated_at": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "type": "string", + "format": "uri" } }, "required": [ - "state", - "closed_at" + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -711759,11 +707469,11 @@ } } }, - "issues-pinned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -711830,15 +707540,45 @@ "content": { "application/json": { "schema": { - "title": "issues pinned event", + "title": "issues edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pinned" + "edited" ] }, + "changes": { + "description": "The changes to the issue.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -712055,7 +707795,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -712153,7 +707894,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -712379,7 +708121,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -712543,7 +708286,10 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "security_and_analysis", + "pull_request_review_thread", + "reminder" ] } }, @@ -712795,7 +708541,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -713138,7 +708885,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -713176,25 +708924,68 @@ "reactions" ] }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "label": { + "title": "Label", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" ] }, "id": { - "type": "integer", - "examples": [ - 1 - ] + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" }, "node_id": { - "type": "string", + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", "examples": [ "MDEyOk9yZ2FuaXphdGlvbjE=" ] @@ -714908,6 +710699,7 @@ }, "required": [ "action", + "changes", "issue", "repository", "sender" @@ -714933,11 +710725,11 @@ } } }, - "issues-reopened": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -715004,13 +710796,13 @@ "content": { "application/json": { "schema": { - "title": "issues reopened event", + "title": "issues labeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "labeled" ] }, "enterprise": { @@ -715129,26 +710921,350 @@ ] }, "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "assignee": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -715231,7 +711347,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -715244,153 +711361,19 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + "description": { "type": [ "string", "null" ] }, - "closed_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time" }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, "html_url": { "type": "string", "format": "uri" @@ -715398,834 +711381,30 @@ "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, "labels_url": { "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] + "format": "uri" }, "node_id": { "type": "string" }, "number": { + "description": "The number of the milestone.", "type": "integer" }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "reminder" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ] }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, "title": { - "description": "Title of the issue", + "description": "The title of the milestone.", "type": "string" }, "updated_at": { @@ -716233,11 +711412,138 @@ "format": "date-time" }, "url": { - "description": "URL for the issue", "type": "string", "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "user": { + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -716320,8 +711626,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -716333,243 +711638,558 @@ "login", "id" ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "updated_at" ] }, - { + "pull_request": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } + "diff_url": { + "type": "string", + "format": "uri" }, - "author_association": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "body": { + "merged_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - "closed_at": { - "type": [ - "string", - "null" - ] + "patch_url": { + "type": "string", + "format": "uri" }, - "comments": { + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { "type": "integer" }, - "comments_url": { - "type": "string" + "-1": { + "type": "integer" }, - "created_at": { - "type": "string" + "confused": { + "type": "integer" }, - "events_url": { - "type": "string" + "eyes": { + "type": "integer" }, - "html_url": { - "type": "string" + "heart": { + "type": "integer" }, - "id": { + "hooray": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } + "laugh": { + "type": "integer" }, - "labels_url": { - "type": "string" + "rocket": { + "type": "integer" }, - "locked": { + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { "type": "boolean" }, - "milestone": { + "email": { "type": [ - "object", + "string", "null" ] }, - "node_id": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "number": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri" }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "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" - } - } + "gists_url": { + "type": "string", + "format": "uri-template" }, - "repository_url": { + "gravatar_id": { "type": "string" }, - "state": { + "html_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "timeline_url": { - "type": "string" + "id": { + "type": "integer" }, - "title": { + "login": { "type": "string" }, - "updated_at": { + "name": { "type": "string" }, - "url": { + "node_id": { "type": "string" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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": [ - "state" + "login", + "id" ] } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] }, "organization": { @@ -718329,11 +713949,11 @@ } } }, - "issues-transferred": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -718400,19 +714020,133 @@ "content": { "application/json": { "schema": { - "title": "issues transferred event", + "title": "issues locked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "locked" ] }, - "changes": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "new_issue": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "allOf": [ + { "title": "Issue", "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", "type": "object", @@ -719001,7 +714735,9 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "reminder", + "security_and_analysis" ] } }, @@ -719634,1407 +715370,182 @@ "reactions" ] }, - "new_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" - } - ] - }, - "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": { + "active_lock_reason": { "type": [ "string", "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { + "assignee": { "type": [ - "string", + "object", "null" ] }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "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" + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "labels_url": { - "type": "string", - "format": "uri-template" + "author_association": { + "type": "string" }, - "language": { + "body": { "type": [ "string", "null" ] }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", + "closed_at": { "type": [ - "object", + "string", "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" ] }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "comments": { + "type": "integer" }, - "name": { - "description": "The name of the repository.", + "comments_url": { "type": "string" }, - "node_id": { + "created_at": { "type": "string" }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { + "events_url": { "type": "string" }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { + "html_url": { "type": "string" }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { + "id": { "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": { + "labels": { "type": "array", "items": { - "type": "string" + "type": [ + "object", + "null" + ] } }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" + "labels_url": { + "type": "string" }, - "visibility": { - "type": "string", + "locked": { + "type": "boolean", "enum": [ - "public", - "private", - "internal" + true ] }, - "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" - ] - } - }, - "required": [ - "new_issue", - "new_repository" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "milestone": { "type": [ - "string", + "object", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { + "number": { "type": "integer" }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", + "performed_via_github_app": { "type": [ "object", "null" - ], + ] + }, + "reactions": { + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { + "+1": { "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "-1": { + "type": "integer" }, - "organizations_url": { - "type": "string", - "format": "uri" + "confused": { + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri" + "eyes": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri" + "heart": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "hooray": { + "type": "integer" }, - "starred_url": { - "type": "string", - "format": "uri-template" + "laugh": { + "type": "integer" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "rocket": { + "type": "integer" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "total_count": { + "type": "integer" }, "url": { - "type": "string", - "format": "uri" + "type": "string" } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" + } }, - "node_id": { + "repository_url": { "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" - ] + "type": "string" + }, + "timeline_url": { + "type": "string" }, "title": { - "description": "The title of the milestone.", "type": "string" }, "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", "type": "string" }, - "node_id": { + "url": { "type": "string" }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], + "user": { + "type": "object", "properties": { "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] + "type": "string" }, "events_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri" + "type": "string" }, "following_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gists_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "gravatar_id": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" @@ -721042,559 +715553,41 @@ "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" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] + "type": "string" } } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "locked", + "active_lock_reason" ] } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" ] }, "organization": { @@ -723329,7 +717322,6 @@ }, "required": [ "action", - "changes", "issue", "repository", "sender" @@ -723355,11 +717347,11 @@ } } }, - "issues-unassigned": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -723426,111 +717418,13 @@ "content": { "application/json": { "schema": { - "title": "issues unassigned event", + "title": "issues milestoned event", "type": "object", "properties": { "action": { - "description": "The action that was performed.", "type": "string", "enum": [ - "unassigned" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "milestoned" ] }, "enterprise": { @@ -723649,350 +717543,26 @@ ] }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -724075,8 +717645,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -724089,189 +717658,997 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "labels_url": { + "draft": { + "type": "boolean" + }, + "events_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "number": { - "description": "The number of the milestone.", + "id": { "type": "integer" }, - "open_issues": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "state": { - "description": "The state of the milestone.", + "labels_url": { "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "format": "uri-template" }, - "updated_at": { - "type": "string", - "format": "date-time" + "locked": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -724366,414 +718743,463 @@ "login", "id" ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] + "closed_issues": { + "type": "integer" }, - "checks": { + "created_at": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" + "description": { + "type": [ + "string", + "null" ] }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "discussions": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "environments": { + "labels_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] + "open_issues": { + "type": "integer" }, - "metadata": { + "state": { + "description": "The state of the milestone.", "type": "string", "enum": [ - "read", - "write" + "open", + "closed" ] }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] + "title": { + "description": "The title of the milestone.", + "type": "string" }, - "organization_hooks": { + "updated_at": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "organization_packages": { + "url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] + "-1": { + "type": "integer" }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] + "confused": { + "type": "integer" }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] + "eyes": { + "type": "integer" }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] + "heart": { + "type": "integer" }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] + "hooray": { + "type": "integer" }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "laugh": { + "type": "integer" }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "rocket": { + "type": "integer" }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] + "total_count": { + "type": "integer" }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] + "events_url": { + "type": "string" }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "followers_url": { + "type": "string" }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] + "following_url": { + "type": "string" }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gists_url": { + "type": "string" }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gravatar_id": { + "type": "string" }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "html_url": { + "type": "string" }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] + "login": { + "type": "string" }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] + "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" } } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" + "milestone" ] + } + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "pull_request": { - "type": "object", + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "diff_url": { + "avatar_url": { "type": "string", "format": "uri" }, - "html_url": { - "type": "string", - "format": "uri" + "deleted": { + "type": "boolean" }, - "merged_at": { + "email": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] + ] }, "events_url": { "type": "string", @@ -724851,30 +719277,79 @@ "login", "id" ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", "html_url", + "labels_url", "id", "node_id", "number", "title", - "user", - "assignees", - "milestone", - "comments", + "description", + "creator", + "open_issues", + "closed_issues", + "state", "created_at", "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "due_on", + "closed_at" ] }, "organization": { @@ -726610,6 +721085,7 @@ "required": [ "action", "issue", + "milestone", "repository", "sender" ] @@ -726634,11 +721110,11 @@ } } }, - "issues-unlabeled": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -726705,475 +721181,40 @@ "content": { "application/json": { "schema": { - "title": "issues unlabeled event", + "title": "issues opened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" + "opened" ] }, - "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "changes": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", + "old_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", "type": [ "object", "null" ], "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -727256,8 +721297,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -727270,19 +721310,152 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, "html_url": { "type": "string", "format": "uri" @@ -727290,30 +721463,829 @@ "id": { "type": "integer" }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, "labels_url": { "type": "string", - "format": "uri" + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, "node_id": { "type": "string" }, "number": { - "description": "The number of the milestone.", "type": "integer" }, - "open_issues": { - "type": "integer" + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" }, "state": { - "description": "The state of the milestone.", + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ "open", "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, "title": { - "description": "The title of the milestone.", + "description": "Title of the issue", "type": "string" }, "updated_at": { @@ -727321,49 +722293,235 @@ "format": "date-time" }, "url": { + "description": "URL for the issue", "type": "string", "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] } }, "required": [ "url", - "html_url", + "repository_url", "labels_url", + "comments_url", + "events_url", + "html_url", "id", "node_id", "number", "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", + "user", + "assignees", + "milestone", + "comments", "created_at", "updated_at", - "due_on", - "closed_at" + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "old_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": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "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": [ @@ -727371,67 +722529,81 @@ "null" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] - } + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" }, - "external_url": { + "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 + }, + "homepage": { "type": [ "string", "null" - ], + ] + }, + "hooks_url": { + "type": "string", "format": "uri" }, "html_url": { @@ -727439,19 +722611,115 @@ "format": "uri" }, "id": { - "description": "Unique identifier of the GitHub app", + "description": "Unique identifier of the repository", + "type": "integer" + }, + "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": [ - "integer", + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" ] }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, "name": { - "description": "The name of the GitHub app", + "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": [ @@ -727549,2421 +722817,249 @@ ] }, "permissions": { - "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "admin": { + "type": "boolean" }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] + "maintain": { + "type": "boolean" }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] + "pull": { + "type": "boolean" }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "push": { + "type": "boolean" }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] + "triage": { + "type": "boolean" } - } + }, + "required": [ + "pull", + "push", + "admin" + ] }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" + "public": { + "type": "boolean" }, - "html_url": { + "pulls_url": { "type": "string", - "format": "uri" + "format": "uri-template" }, - "merged_at": { - "type": [ - "string", - "null" + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" + "type": [ + "null", + "integer", + "string" + ] }, - "url": { + "releases_url": { "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" + "format": "uri-template" }, - "heart": { - "type": "integer" + "role_name": { + "type": [ + "string", + "null" + ] }, - "hooray": { + "size": { "type": "integer" }, - "laugh": { - "type": "integer" + "ssh_url": { + "type": "string" }, - "rocket": { + "stargazers": { "type": "integer" }, - "total_count": { + "stargazers_count": { "type": "integer" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { + "stargazers_url": { "type": "string", "format": "uri" }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { + "statuses_url": { "type": "string", "format": "uri-template" }, - "followers_url": { + "subscribers_url": { "type": "string", "format": "uri" }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { + "subscription_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { + "svn_url": { "type": "string", "format": "uri" }, - "received_events_url": { + "tags_url": { "type": "string", "format": "uri" }, - "repos_url": { + "teams_url": { "type": "string", "format": "uri" }, - "site_admin": { - "type": "boolean" + "topics": { + "type": "array", + "items": { + "type": "string" + } }, - "starred_url": { + "trees_url": { "type": "string", "format": "uri-template" }, - "subscriptions_url": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { "type": "string", "format": "uri" }, - "type": { + "visibility": { "type": "string", "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "public", + "private", + "internal" ] }, - "url": { - "type": "string", - "format": "uri" + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" } }, "required": [ - "login", - "id" + "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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" ] } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "old_issue", + "old_repository" ] }, - "label": { - "title": "Label", + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, "description": { + "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, - "id": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "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" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "action", - "issue", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "issues", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "issues-unlocked": { - "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "issues unlocked event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "unlocked" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", @@ -730480,7 +723576,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -730644,7 +723741,10 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "security_and_analysis", + "pull_request_review_thread", + "reminder" ] } }, @@ -730896,7 +723996,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -731282,6 +724383,7 @@ "properties": { "active_lock_reason": { "type": [ + "string", "null" ] }, @@ -731346,10 +724448,7 @@ "type": "string" }, "locked": { - "type": "boolean", - "enum": [ - false - ] + "type": "boolean" }, "milestone": { "type": [ @@ -731365,6 +724464,7 @@ }, "performed_via_github_app": { "type": [ + "object", "null" ] }, @@ -731407,7 +724507,11 @@ "type": "string" }, "state": { - "type": "string" + "type": "string", + "enum": [ + "open", + "closed" + ] }, "timeline_url": { "type": "string" @@ -731482,8 +724586,8 @@ } }, "required": [ - "locked", - "active_lock_reason" + "state", + "closed_at" ] } ] @@ -733245,11 +726349,11 @@ } } }, - "issues-unpinned": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -733316,13 +726420,13 @@ "content": { "application/json": { "schema": { - "title": "issues unpinned event", + "title": "issues pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpinned" + "pinned" ] }, "enterprise": { @@ -736419,13 +729523,13 @@ } } }, - "label-created": { + "issues-reopened": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -736490,13 +729594,13 @@ "content": { "application/json": { "schema": { - "title": "label created event", + "title": "issues reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "reopened" ] }, "enterprise": { @@ -736614,47 +729718,1448 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" + "issue": { + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, - "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" + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "state" + ] } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" ] }, "organization": { @@ -738389,8 +732894,9 @@ }, "required": [ "action", - "label", - "repository" + "issue", + "repository", + "sender" ] } } @@ -738404,7 +732910,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -738413,13 +732919,13 @@ } } }, - "label-deleted": { + "issues-transferred": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -738484,2052 +732990,1866 @@ "content": { "application/json": { "schema": { - "title": "label deleted event", + "title": "issues transferred event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" + "transferred" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", + "changes": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + "new_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { + "avatar_url": { "type": "string", - "examples": [ - "MIT License" - ] + "format": "uri" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] + "deleted": { + "type": "boolean" }, - "spdx_id": { + "email": { "type": [ "string", "null" - ], - "examples": [ - "MIT" ] }, - "node_id": { + "events_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "format": "uri-template" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, "type": { "type": "string", - "examples": [ - "User" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } }, - "push": { - "type": "boolean" + "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" + ] }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "email": { + "closed_at": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + ], + "format": "date-time" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "comments": { + "type": "integer" }, - "node_id": { + "comments_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri" }, - "avatar_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "date-time" }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "draft": { + "type": "boolean" }, - "url": { + "events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "format": "uri" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "gists_url": { + "labels_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri-template" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "locked": { + "type": "boolean" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "node_id": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "received_events_url": { + "repository_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, - "type": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "examples": [ - "User" + "enum": [ + "open", + "closed" ] }, - "site_admin": { - "type": "boolean" + "state_reason": { + "type": [ + "string", + "null" + ] }, - "starred_at": { + "timeline_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "name": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" }, - "full_name": { - "type": "string" + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" }, - "owner": { - "type": "object", + "user": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, "avatar_url": { - "type": "string" + "type": "string", + "format": "uri" }, - "gravatar_id": { - "type": "string" + "deleted": { + "type": "boolean" }, - "url": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "html_url": { - "type": "string" + "events_url": { + "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" }, - "starred_url": { + "gravatar_id": { "type": "string" }, - "subscriptions_url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "organizations_url": { + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "repos_url": { + "name": { "type": "string" }, - "events_url": { + "node_id": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, "received_events_url": { - "type": "string" + "type": "string", + "format": "uri" }, - "type": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, "site_admin": { "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "new_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 }, - "private": { + "allow_forking": { + "description": "Whether to allow private forks", "type": "boolean" }, - "html_url": { - "type": "string" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "description": { - "type": "string" + "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" + "allow_update_branch": { + "type": "boolean" }, "archive_url": { - "type": "string" + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false }, "assignees_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "blobs_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "branches_url": { - "type": "string" + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" }, "collaborators_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "comments_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "commits_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "compare_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "contents_url": { - "type": "string" + "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" + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" }, "downloads_url": { - "type": "string" + "type": "string", + "format": "uri" }, "events_url": { - "type": "string" + "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" + "type": "string", + "format": "uri-template" }, "git_refs_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "git_tags_url": { - "type": "string" + "type": "string", + "format": "uri-template" }, "git_url": { - "type": "string" + "type": "string", + "format": "uri" }, - "issue_comment_url": { - "type": "string" + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true }, - "issue_events_url": { - "type": "string" + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true }, - "issues_url": { - "type": "string" + "has_pages": { + "type": "boolean" }, - "keys_url": { - "type": "string" + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true }, - "labels_url": { - "type": "string" + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true }, - "languages_url": { - "type": "string" + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false }, - "merges_url": { - "type": "string" + "homepage": { + "type": [ + "string", + "null" + ] }, - "milestones_url": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri" }, - "notifications_url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "pulls_url": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer" }, - "releases_url": { - "type": "string" + "is_template": { + "type": "boolean" }, - "ssh_url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "format": "uri-template" }, - "stargazers_url": { - "type": "string" + "issue_events_url": { + "type": "string", + "format": "uri-template" }, - "statuses_url": { - "type": "string" + "issues_url": { + "type": "string", + "format": "uri-template" }, - "subscribers_url": { - "type": "string" + "keys_url": { + "type": "string", + "format": "uri-template" }, - "subscription_url": { - "type": "string" + "labels_url": { + "type": "string", + "format": "uri-template" }, - "tags_url": { - "type": "string" + "language": { + "type": [ + "string", + "null" + ] }, - "teams_url": { - "type": "string" + "languages_url": { + "type": "string", + "format": "uri" }, - "trees_url": { - "type": "string" + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] }, - "clone_url": { + "master_branch": { "type": "string" }, - "mirror_url": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri" }, - "hooks_url": { - "type": "string" + "milestones_url": { + "type": "string", + "format": "uri-template" }, - "svn_url": { - "type": "string" + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "homepage": { + "name": { + "description": "The name of the repository.", "type": "string" }, - "language": { + "node_id": { "type": "string" }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" + "notifications_url": { + "type": "string", + "format": "uri-template" }, - "size": { + "open_issues": { "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": { + "organization": { "type": "string" }, - "permissions": { - "type": "object", + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "avatar_url": { + "type": "string", + "format": "uri" }, - "push": { + "deleted": { "type": "boolean" }, - "triage": { + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { "type": "boolean" }, "pull": { "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" } - } + }, + "required": [ + "pull", + "push", + "admin" + ] }, - "allow_rebase_merge": { + "private": { + "description": "Whether the repository is private or public.", "type": "boolean" }, - "temp_clone_token": { + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { "type": "string" }, - "allow_squash_merge": { - "type": "boolean" + "stargazers": { + "type": "integer" }, - "allow_auto_merge": { - "type": "boolean" + "stargazers_count": { + "type": "integer" }, - "delete_branch_on_merge": { - "type": "boolean" + "stargazers_url": { + "type": "string", + "format": "uri" }, - "allow_update_branch": { - "type": "boolean" + "statuses_url": { + "type": "string", + "format": "uri-template" }, - "use_squash_pr_title_as_default": { - "type": "boolean" + "subscribers_url": { + "type": "string", + "format": "uri" }, - "squash_merge_commit_title": { + "subscription_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": { + "svn_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": { + "tags_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": { + "teams_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": { - "type": "boolean" + "topics": { + "type": "array", + "items": { + "type": "string" + } }, - "subscribers_count": { + "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" }, - "network_count": { + "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + }, + "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" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "label", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "label", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "label-edited": { - "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "label edited event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" + "new_issue", + "new_repository" ] }, - "changes": { - "description": "The changes to the label if the action was `edited`.", - "type": "object", - "properties": { - "color": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the color if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "description": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the description 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" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -740645,47 +734965,1226 @@ "node_id" ] }, - "label": { - "title": "Label", + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", "type": "object", "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "default": { - "type": "boolean" + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "name": { - "description": "The name of the label.", - "type": "string" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, "node_id": { "type": "string" }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, "url": { - "description": "URL for the label", + "description": "URL for the issue", "type": "string", "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] } }, "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "url", - "name", - "color", - "default", - "description" + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, "organization": { @@ -742420,7 +737919,8 @@ }, "required": [ "action", - "label", + "changes", + "issue", "repository", "sender" ] @@ -742436,7 +737936,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -742445,13 +737945,13 @@ } } }, - "marketplace-purchase-cancelled": { + "issues-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -742516,17 +738016,112 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase cancelled event", + "title": "issues unassigned event", "type": "object", "properties": { "action": { + "description": "The action that was performed.", "type": "string", "enum": [ - "cancelled" + "unassigned" ] }, - "effective_date": { - "type": "string" + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, "enterprise": { "title": "Enterprise", @@ -742643,215 +738238,1233 @@ "node_id" ] }, - "marketplace_purchase": { - "allOf": [ - { - "title": "Marketplace Purchase", - "type": "object", + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "account": { - "type": "object", + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "type", - "id", - "node_id", "login", - "organization_billing_email" + "id" ] }, - "billing_cycle": { + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { "type": "string" }, - "free_trial_ends_on": { + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { "type": [ "string", "null" ] }, - "next_billing_date": { + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { "type": [ "string", "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" ] }, - "on_free_trial": { - "type": "boolean" + "name": { + "description": "The name of the GitHub app", + "type": "string" }, - "plan": { - "type": "object", + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } + "avatar_url": { + "type": "string", + "format": "uri" }, - "description": { + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "has_free_trial": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "monthly_price_in_cents": { - "type": "integer" + "login": { + "type": "string" }, "name": { "type": "string" }, - "price_model": { + "node_id": { "type": "string" }, - "unit_name": { - "type": [ - "string", - "null" + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, - "yearly_price_in_cents": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" + "login", + "id" ] }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, - { - "type": "object", - "properties": { - "account": { + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "id": { - "type": "integer" + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "login": { - "type": "string" + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "node_id": { - "type": "string" + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "organization_billing_email": { - "type": [ - "string", - "null" + "content_references": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "type": { - "type": "string" + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] } } }, - "billing_cycle": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string" }, - "free_trial_ends_on": { + "updated_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" }, - "next_billing_date": { + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - "on_free_trial": { + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { "type": "boolean" }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - } + "email": { + "type": [ + "string", + "null" + ] }, - "unit_count": { + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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": [ - "next_billing_date" + "login", + "id" ] } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, "organization": { @@ -742953,119 +739566,6 @@ "description" ] }, - "previous_marketplace_purchase": { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -744699,9 +741199,9 @@ }, "required": [ "action", - "effective_date", - "sender", - "marketplace_purchase" + "issue", + "repository", + "sender" ] } } @@ -744715,20 +741215,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace-purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -744793,18 +741295,15 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase changed event", + "title": "issues unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "changed" + "unlabeled" ] }, - "effective_date": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -744920,431 +741419,1375 @@ "node_id" ] }, - "marketplace_purchase": { - "allOf": [ - { - "title": "Marketplace Purchase", - "type": "object", + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] + "avatar_url": { + "type": "string", + "format": "uri" }, - "billing_cycle": { - "type": "string" + "deleted": { + "type": "boolean" }, - "free_trial_ends_on": { + "email": { "type": [ "string", "null" ] }, - "next_billing_date": { - "type": [ - "string", - "null" - ] + "events_url": { + "type": "string", + "format": "uri-template" }, - "on_free_trial": { - "type": "boolean" + "followers_url": { + "type": "string", + "format": "uri" }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "unit_count": { + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, - { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - } }, - "billing_cycle": { + "login": { "type": "string" }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] + "name": { + "type": "string" }, - "next_billing_date": { - "type": [ - "string", - "null" - ] + "node_id": { + "type": "string" }, - "on_free_trial": { + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { "type": "boolean" }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - } + "starred_url": { + "type": "string", + "format": "uri-template" }, - "unit_count": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "next_billing_date" + "login", + "id" ] - } - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "examples": [ - "github" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "id": { - "type": "integer", - "examples": [ - 1 + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] + "format": "uri" }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] + "format": "date-time" + }, + "draft": { + "type": "boolean" }, "events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] + "format": "uri" }, - "hooks_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] + "format": "uri" }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] + "id": { + "type": "integer" }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "public_members_url": { + "labels_url": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] + "format": "uri-template" }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "locked": { + "type": "boolean" }, - "description": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "previous_marketplace_purchase": { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", "properties": { - "id": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { "type": "integer" }, - "login": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "node_id": { - "type": "string" + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, - "organization_billing_email": { + "description": { "type": [ "string", "null" ] }, - "type": { + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "type", + "url", + "html_url", + "labels_url", "id", "node_id", - "login", - "organization_billing_email" + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, - "billing_cycle": { + "node_id": { "type": "string" }, - "free_trial_ends_on": { + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "next_billing_date": { + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ "string", "null" ] }, - "on_free_trial": { + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", "type": [ - "boolean", + "object", "null" - ] - }, - "plan": { - "type": "object", + ], "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } + "avatar_url": { + "type": "string", + "format": "uri" }, - "description": { + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "has_free_trial": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "monthly_price_in_cents": { - "type": "integer" + "login": { + "type": "string" }, "name": { "type": "string" }, - "price_model": { + "node_id": { "type": "string" }, - "unit_name": { - "type": [ - "string", - "null" + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "yearly_price_in_cents": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" ] }, - "unit_count": { + "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": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, "repository": { @@ -746980,9 +744423,9 @@ }, "required": [ "action", - "effective_date", - "sender", - "marketplace_purchase" + "issue", + "repository", + "sender" ] } } @@ -746996,20 +744439,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace-purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -747074,18 +744519,15 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase pending_change event", + "title": "issues unlocked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pending_change" + "unlocked" ] }, - "effective_date": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -747201,683 +744643,1793 @@ "node_id" ] }, - "marketplace_purchase": { + "issue": { "allOf": [ { - "title": "Marketplace Purchase", + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", "type": "object", "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { + "active_lock_reason": { "type": [ "string", "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "next_billing_date": { + "assignee": { + "title": "User", "type": [ - "string", + "object", "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", + ], "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri" }, - "has_free_trial": { + "deleted": { "type": "boolean" }, - "id": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] }, - "monthly_price_in_cents": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "name": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "price_model": { + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "unit_name": { - "type": [ - "string", - "null" - ] + "html_url": { + "type": "string", + "format": "uri" }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, - { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, + "name": { + "type": "string" + }, "node_id": { "type": "string" }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - } - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" + }, + "required": [ + "login", + "id" ] }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } + "required": [ + "login", + "id" + ] } }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "next_billing_date" - ] - } - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "previous_marketplace_purchase": { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" + "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" + ] }, - "organization_billing_email": { + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "description": { - "type": "string" + "comments": { + "type": "integer" }, - "has_free_trial": { + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { "type": "boolean" }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "monthly_price_in_cents": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "name": { - "type": "string" + "labels_url": { + "type": "string", + "format": "uri-template" }, - "price_model": { - "type": "string" + "locked": { + "type": "boolean" }, - "unit_name": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + ], "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { + "closed_at": { "type": [ "string", "null" ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] + "format": "date-time" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "closed_issues": { + "type": "integer" }, - "node_id": { + "created_at": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "creator": { + "title": "User", "type": [ - "string", + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, - "email": { + "description": { "type": [ "string", "null" ] }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { + "due_on": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "format": "date-time" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "id": { + "type": "integer" }, - "starred_url": { + "labels_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "format": "uri" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "node_id": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "open_issues": { + "type": "integer" }, - "events_url": { + "state": { + "description": "The state of the milestone.", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "enum": [ + "open", + "closed" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "title": { + "description": "The title of the milestone.", + "type": "string" }, - "type": { + "updated_at": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "format": "date-time" }, - "starred_at": { + "url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "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", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean", + "enum": [ + false + ] + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "locked", + "active_lock_reason" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", "starred_url", "subscriptions_url", "type", @@ -749258,9 +747810,9 @@ }, "required": [ "action", - "effective_date", - "sender", - "marketplace_purchase" + "issue", + "repository", + "sender" ] } } @@ -749274,20 +747826,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace-purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change-cancelled": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -749352,18 +747906,15 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase pending_change_cancelled event", + "title": "issues unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pending_change_cancelled" + "unpinned" ] }, - "effective_date": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -749479,485 +748030,1466 @@ "node_id" ] }, - "marketplace_purchase": { - "allOf": [ - { - "title": "Marketplace Purchase", - "type": "object", + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri" }, - "free_trial_ends_on": { - "type": [ - "null" - ] + "deleted": { + "type": "boolean" }, - "next_billing_date": { + "email": { "type": [ "string", "null" ] }, - "on_free_trial": { + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { "type": "boolean" }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, - "unit_count": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" + "login", + "id" ] }, - { - "type": "object", - "properties": { - "next_billing_date": { - "type": "string" - } - }, - "required": [ - "next_billing_date" - ] - } - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "examples": [ - "github" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "id": { - "type": "integer", - "examples": [ - 1 + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] + "format": "uri" }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] + "format": "date-time" + }, + "draft": { + "type": "boolean" }, "events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] + "format": "uri" }, - "hooks_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] + "format": "uri" }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] + "id": { + "type": "integer" }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "public_members_url": { + "labels_url": { "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] + "format": "uri-template" }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "locked": { + "type": "boolean" }, - "description": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "previous_marketplace_purchase": { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { + "closed_at": { "type": [ "string", "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" + ], + "format": "date-time" }, - "monthly_price_in_cents": { + "closed_issues": { "type": "integer" }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "unit_name": { + "creator": { + "title": "User", "type": [ - "string", + "object", "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + ], "properties": { - "key": { + "avatar_url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri" }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "deleted": { + "type": "boolean" }, - "url": { + "email": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "events_url": { + "type": "string", + "format": "uri-template" }, - "node_id": { + "followers_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] }, - "email": { - "type": [ - "string", - "null" - ] + "id": { + "type": "integer" }, "login": { - "type": "string", - "examples": [ - "octocat" - ] + "type": "string" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "name": { + "type": "string" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { "type": [ @@ -751452,9 +750984,9 @@ }, "required": [ "action", - "effective_date", - "sender", - "marketplace_purchase" + "issue", + "repository", + "sender" ] } } @@ -751468,20 +751000,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace-purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-purchased": { + "label-created": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -751546,18 +751080,15 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase purchased event", + "title": "label created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "purchased" + "created" ] }, - "effective_date": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -751673,215 +751204,47 @@ "node_id" ] }, - "marketplace_purchase": { - "allOf": [ - { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" }, - { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - } - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - } - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "next_billing_date" + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] }, "organization": { @@ -751983,119 +751346,6 @@ "description" ] }, - "previous_marketplace_purchase": { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -753729,9 +752979,8 @@ }, "required": [ "action", - "effective_date", - "sender", - "marketplace_purchase" + "label", + "repository" ] } } @@ -753745,20 +752994,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace-purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "member-added": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -753823,36 +753074,15 @@ "content": { "application/json": { "schema": { - "title": "member added event", + "title": "label deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "added" + "deleted" ] }, - "changes": { - "type": "object", - "properties": { - "permission": { - "type": "object", - "properties": { - "to": { - "type": "string", - "enum": [ - "write", - "admin", - "read" - ] - } - }, - "required": [ - "to" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -753968,100 +753198,47 @@ "node_id" ] }, - "member": { - "title": "User", - "type": [ - "object", - "null" - ], + "label": { + "title": "Label", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" }, - "deleted": { + "default": { "type": "boolean" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, "id": { "type": "integer" }, - "login": { - "type": "string" - }, "name": { + "description": "The name of the label.", "type": "string" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, "url": { + "description": "URL for the label", "type": "string", "format": "uri" } }, "required": [ - "login", - "id" + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] }, "organization": { @@ -755796,7 +754973,7 @@ }, "required": [ "action", - "member", + "label", "repository", "sender" ] @@ -755812,9 +754989,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "label", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -755822,13 +754998,13 @@ } } }, - "member-edited": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -755893,7 +755069,7 @@ "content": { "application/json": { "schema": { - "title": "member edited event", + "title": "label edited event", "type": "object", "properties": { "action": { @@ -755903,14 +755079,14 @@ ] }, "changes": { - "description": "The changes to the collaborator permissions", + "description": "The changes to the label if the action was `edited`.", "type": "object", "properties": { - "old_permission": { + "color": { "type": "object", "properties": { "from": { - "description": "The previous permissions of the collaborator if the action was edited.", + "description": "The previous version of the color if the action was `edited`.", "type": "string" } }, @@ -755918,22 +755094,29 @@ "from" ] }, - "permission": { + "description": { "type": "object", "properties": { "from": { - "type": [ - "string", - "null" - ] - }, - "to": { - "type": [ - "string", - "null" - ] + "description": "The previous version of the description 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" + ] } } }, @@ -756052,100 +755235,47 @@ "node_id" ] }, - "member": { - "title": "User", - "type": [ - "object", - "null" - ], + "label": { + "title": "Label", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" }, - "deleted": { + "default": { "type": "boolean" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, "id": { "type": "integer" }, - "login": { - "type": "string" - }, "name": { + "description": "The name of the label.", "type": "string" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, "url": { + "description": "URL for the label", "type": "string", "format": "uri" } }, "required": [ - "login", - "id" + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] }, "organization": { @@ -757880,8 +757010,7 @@ }, "required": [ "action", - "changes", - "member", + "label", "repository", "sender" ] @@ -757897,9 +757026,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "label", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -757907,13 +757035,13 @@ } } }, - "member-removed": { + "marketplace-purchase-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, "parameters": [ { @@ -757978,15 +757106,18 @@ "content": { "application/json": { "schema": { - "title": "member removed event", + "title": "marketplace_purchase cancelled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "removed" + "cancelled" ] }, + "effective_date": { + "type": "string" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -758102,100 +757233,215 @@ "node_id" ] }, - "member": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "marketplace_purchase": { + "allOf": [ + { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "next_billing_date" ] - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "login", - "id" ] }, "organization": { @@ -758297,6 +757543,119 @@ "description" ] }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -759930,9 +759289,9 @@ }, "required": [ "action", - "member", - "repository", - "sender" + "effective_date", + "sender", + "marketplace_purchase" ] } } @@ -759946,23 +759305,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace-purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "membership-added": { + "marketplace-purchase-changed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, "parameters": [ { @@ -760027,15 +759383,18 @@ "content": { "application/json": { "schema": { - "title": "membership added event", + "title": "marketplace_purchase changed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "added" + "changed" ] }, + "effective_date": { + "type": "string" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -760151,100 +759510,215 @@ "node_id" ] }, - "member": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "marketplace_purchase": { + "allOf": [ + { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "next_billing_date" ] - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "login", - "id" ] }, "organization": { @@ -760346,6 +759820,123 @@ "description" ] }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": [ + "boolean", + "null" + ] + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -761815,26 +761406,16 @@ "updated_at" ] }, - "scope": { - "description": "The scope of the membership. Currently, can only be `team`.", - "type": "string", - "enum": [ - "team" - ] - }, "sender": { - "title": "User", - "type": [ - "object", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -761842,225 +761423,156 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "html_url": { + "url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "organizations_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "received_events_url": { + "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "repos_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "site_admin": { - "type": "boolean" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, "starred_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, "subscriptions_url": { "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "url": { + "organizations_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "html_url": { + "repos_url": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "members_url": { + "events_url": { "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { + "received_events_url": { "type": "string", - "enum": [ - "open", - "closed", - "secret" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "repositories_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, - "slug": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "url": { - "description": "URL for the team", + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "name", - "id" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", - "scope", - "member", + "effective_date", "sender", - "team", - "organization" + "marketplace_purchase" ] } } @@ -762074,22 +761586,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "marketplace-purchase", "supported-webhook-types": [ - "organization", - "business", - "app" + "marketplace" ] } } }, - "membership-removed": { + "marketplace-purchase-pending-change": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, "parameters": [ { @@ -762154,15 +761664,18 @@ "content": { "application/json": { "schema": { - "title": "membership removed event", + "title": "marketplace_purchase pending_change event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "removed" + "pending_change" ] }, + "effective_date": { + "type": "string" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -762278,100 +761791,215 @@ "node_id" ] }, - "member": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "marketplace_purchase": { + "allOf": [ + { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "next_billing_date" ] - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "login", - "id" ] }, "organization": { @@ -762473,6 +762101,120 @@ "description" ] }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -763942,27 +763684,16 @@ "updated_at" ] }, - "scope": { - "description": "The scope of the membership. Currently, can only be `team`.", - "type": "string", - "enum": [ - "team", - "organization" - ] - }, "sender": { - "title": "User", - "type": [ - "object", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -763970,225 +763701,156 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "html_url": { + "url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "organizations_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "received_events_url": { + "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "repos_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "site_admin": { - "type": "boolean" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, "starred_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, "subscriptions_url": { "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "url": { + "organizations_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "html_url": { + "repos_url": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "members_url": { + "events_url": { "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { + "received_events_url": { "type": "string", - "enum": [ - "open", - "closed", - "secret" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "repositories_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, - "slug": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "url": { - "description": "URL for the team", + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "name", - "id" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", - "scope", - "member", + "effective_date", "sender", - "team", - "organization" + "marketplace_purchase" ] } } @@ -764202,25 +763864,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "marketplace-purchase", "supported-webhook-types": [ - "organization", - "business", - "app" + "marketplace" ] } } }, - "merge-group-checks-requested": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, "parameters": [ { @@ -764285,11 +763942,108 @@ "content": { "application/json": { "schema": { + "title": "marketplace_purchase pending_change_cancelled event", "type": "object", "properties": { "action": { + "type": "string", + "enum": [ + "pending_change_cancelled" + ] + }, + "effective_date": { "type": "string" }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -764315,117 +764069,132 @@ "node_id" ] }, - "merge_group": { - "title": "MergeGroup", - "type": "object", - "properties": { - "head_sha": { - "description": "The SHA of the merge group.", - "type": "string" - }, - "head_ref": { - "description": "The full ref of the merge group.", - "type": "string" - }, - "base_sha": { - "description": "The SHA of the merge group's parent commit.", - "type": "string" - }, - "base_ref": { - "description": "The full ref of the branch the merge group will be merged into.", - "type": "string" - }, - "head_commit": { - "title": "SimpleCommit", + "marketplace_purchase": { + "allOf": [ + { + "title": "Marketplace Purchase", "type": "object", "properties": { - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", + "account": { "type": "object", "properties": { - "date": { - "type": "string", - "format": "date-time" + "id": { + "type": "integer" }, - "email": { + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { "type": [ "string", "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" + ] }, - "username": { + "type": { "type": "string" } }, "required": [ - "email", - "name" + "type", + "id", + "node_id", + "login", + "organization_billing_email" ] }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { "type": "object", "properties": { - "date": { - "type": "string", - "format": "date-time" + "bullets": { + "type": "array", + "items": { + "type": "string" + } }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" }, "name": { - "description": "The git author's name.", "type": "string" }, - "username": { + "price_model": { "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" } }, "required": [ - "email", - "name" + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" ] }, - "id": { - "type": "string" - }, - "message": { - "type": "string" - }, - "timestamp": { - "type": "string" - }, - "tree_id": { + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, + { + "type": "object", + "properties": { + "next_billing_date": { "type": "string" } }, "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" + "next_billing_date" ] } - }, - "required": [ - "head_sha", - "head_ref", - "base_sha", - "base_ref", - "head_commit" ] }, "organization": { @@ -764527,6 +764296,119 @@ "description" ] }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -766160,7 +766042,9 @@ }, "required": [ "action", - "merge_group" + "effective_date", + "sender", + "marketplace_purchase" ] } } @@ -766174,20 +766058,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge-group", + "subcategory": "marketplace-purchase", "supported-webhook-types": [ - "app" + "marketplace" ] } } }, - "meta-deleted": { + "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, "parameters": [ { @@ -766252,15 +766136,18 @@ "content": { "application/json": { "schema": { - "title": "meta deleted event", + "title": "marketplace_purchase purchased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "purchased" ] }, + "effective_date": { + "type": "string" + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -766351,132 +766238,6 @@ "avatar_url" ] }, - "hook": { - "description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.", - "type": "object", - "properties": { - "active": { - "type": "boolean" - }, - "config": { - "type": "object", - "properties": { - "content_type": { - "type": "string", - "enum": [ - "json", - "form" - ] - }, - "insecure_ssl": { - "type": "string" - }, - "secret": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "content_type", - "insecure_ssl", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "*", - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "create", - "delete", - "deployment", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "meta", - "milestone", - "organization", - "org_block", - "package", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "pull_request_review_thread", - "push", - "registry_package", - "release", - "repository", - "repository_import", - "repository_vulnerability_alert", - "secret_scanning_alert", - "secret_scanning_alert_location", - "security_and_analysis", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_job", - "workflow_run", - "repository_dispatch", - "projects_v2_item" - ], - "minItems": 1 - } - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "name", - "active", - "events", - "config", - "updated_at", - "created_at" - ] - }, - "hook_id": { - "description": "The id of the modified webhook.", - "type": "integer" - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -766502,6 +766263,217 @@ "node_id" ] }, + "marketplace_purchase": { + "allOf": [ + { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, + { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "next_billing_date" + ] + } + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -766601,301 +766573,218 @@ "description" ] }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] + "type": "integer" + }, + "login": { + "type": "string" }, "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "type": "string" }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" + "organization_billing_email": { + "type": [ + "string", + "null" ] }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "description": { + "type": "string" }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" ] }, - "forks": { + "yearly_price_in_cents": { "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "permissions": { + { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "admin": { - "type": "boolean" + "key": { + "type": "string", + "examples": [ + "mit" + ] }, - "pull": { - "type": "boolean" + "name": { + "type": "string", + "examples": [ + "MIT License" + ] }, - "triage": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "push": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "maintain": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -767055,363 +766944,897 @@ "type", "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, + "pull": { "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "triage": { + "type": "boolean" }, - "description": { + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "octocat" ] }, - "archive_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + 1 ] }, - "assignees_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "MDQ6VXNlcjE=" ] }, - "blobs_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "branches_url": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat" ] }, - "collaborators_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://github.com/octocat" ] }, - "comments_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/followers" ] }, - "commits_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "forks_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/received_events" ] }, - "git_commits_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "User" ] }, - "git_refs_url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "\"2020-07-09T00:17:55Z\"" ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" }, "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "type": "string" }, "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "type": "string" }, "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] + "type": "string" }, "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] + "type": "string" }, "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] + "type": "string" }, "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "type": "string" }, "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] + "type": "string" }, "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] + "type": "string" }, "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] + "type": "string" }, "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] + "type": "string" }, "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "type": "string" }, "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] + "type": "string" }, "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "type": "string" }, "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] + "type": "string" }, "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] + "type": "string" }, "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] + "type": "string" }, "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] + "type": "string" }, "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] + "type": "string" }, "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "type": "string" }, "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] + "type": "string" }, "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "type": "string" }, "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] + "type": "string" }, "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] + "type": "string" }, "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "type": "string" }, "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] + "type": "string" }, "language": { - "type": [ - "string", - "null" - ] + "type": "string" }, "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "type": "integer" }, "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "type": "string" }, "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "topics": { "type": "array", @@ -767420,507 +767843,78 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "type": "string" }, "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "type": "string" }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "string" }, - "template_repository": { - "type": [ - "object", - "null" - ], + "permissions": { + "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": { + "admin": { "type": "boolean" }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { + "maintain": { "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" + "push": { + "type": "boolean" }, - "teams_url": { - "type": "string" + "triage": { + "type": "boolean" }, - "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": { + "pull": { "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" } } }, + "allow_rebase_merge": { + "type": "boolean" + }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true + "type": "boolean" }, "squash_merge_commit_title": { "type": "string", @@ -767957,20 +767951,6 @@ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, "type": "boolean" }, "subscribers_count": { @@ -767978,103 +767958,201 @@ }, "network_count": { "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, "sender": { @@ -768241,8 +768319,9 @@ }, "required": [ "action", - "hook_id", - "hook" + "effective_date", + "sender", + "marketplace_purchase" ] } } @@ -768256,24 +768335,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "marketplace-purchase", "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "milestone-closed": { + "member-added": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -768338,15 +768413,36 @@ "content": { "application/json": { "schema": { - "title": "milestone closed event", + "title": "member added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed" + "added" ] }, + "changes": { + "type": "object", + "properties": { + "permission": { + "type": "object", + "properties": { + "to": { + "type": "string", + "enum": [ + "write", + "admin", + "read" + ] + } + }, + "required": [ + "to" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -768462,134 +768558,44 @@ "node_id" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", + "member": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "closed_at": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "description": { - "type": [ - "string", - "null" - ] + "gists_url": { + "type": "string", + "format": "uri-template" }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -768598,35 +768604,45 @@ "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "repos_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "site_admin": { + "type": "boolean" }, - "updated_at": { + "starred_url": { "type": "string", - "format": "date-time" + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { "type": "string", @@ -768634,22 +768650,8 @@ } }, "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" + "login", + "id" ] }, "organization": { @@ -770384,7 +770386,7 @@ }, "required": [ "action", - "milestone", + "member", "repository", "sender" ] @@ -770400,8 +770402,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -770409,13 +770412,13 @@ } } }, - "milestone-created": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -770480,15 +770483,50 @@ "content": { "application/json": { "schema": { - "title": "milestone created event", + "title": "member edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "edited" ] }, + "changes": { + "description": "The changes to the collaborator permissions", + "type": "object", + "properties": { + "old_permission": { + "type": "object", + "properties": { + "from": { + "description": "The previous permissions of the collaborator if the action was edited.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "permission": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": [ + "string", + "null" + ] + } + } + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -770604,133 +770642,44 @@ "node_id" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", + "member": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "closed_at": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "description": { - "type": [ - "string", - "null" - ] + "gists_url": { + "type": "string", + "format": "uri-template" }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -770739,35 +770688,45 @@ "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "repos_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "site_admin": { + "type": "boolean" }, - "updated_at": { + "starred_url": { "type": "string", - "format": "date-time" + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { "type": "string", @@ -770775,22 +770734,8 @@ } }, "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" + "login", + "id" ] }, "organization": { @@ -772525,7 +772470,8 @@ }, "required": [ "action", - "milestone", + "changes", + "member", "repository", "sender" ] @@ -772541,8 +772487,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -772550,13 +772497,13 @@ } } }, - "milestone-deleted": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -772621,13 +772568,13 @@ "content": { "application/json": { "schema": { - "title": "milestone deleted event", + "title": "member removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "removed" ] }, "enterprise": { @@ -772745,134 +772692,44 @@ "node_id" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", + "member": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "closed_at": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "description": { - "type": [ - "string", - "null" - ] + "gists_url": { + "type": "string", + "format": "uri-template" }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -772881,35 +772738,45 @@ "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "repos_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "site_admin": { + "type": "boolean" }, - "updated_at": { + "starred_url": { "type": "string", - "format": "date-time" + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { "type": "string", @@ -772917,22 +772784,8 @@ } }, "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" + "login", + "id" ] }, "organization": { @@ -774667,7 +774520,7 @@ }, "required": [ "action", - "milestone", + "member", "repository", "sender" ] @@ -774683,8 +774536,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -774692,13 +774546,13 @@ } } }, - "milestone-edited": { + "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -774763,57 +774617,15 @@ "content": { "application/json": { "schema": { - "title": "milestone edited event", + "title": "membership added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "added" ] }, - "changes": { - "description": "The changes to the milestone if the action was `edited`.", - "type": "object", - "properties": { - "description": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the description if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "due_on": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the due date if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -774929,134 +774741,44 @@ "node_id" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", + "member": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "closed_at": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "description": { - "type": [ - "string", - "null" - ] + "gists_url": { + "type": "string", + "format": "uri-template" }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -775065,35 +774787,45 @@ "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "repos_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "site_admin": { + "type": "boolean" }, - "updated_at": { + "starred_url": { "type": "string", - "format": "date-time" + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { "type": "string", @@ -775101,22 +774833,8 @@ } }, "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" + "login", + "id" ] }, "organization": { @@ -776687,16 +776405,26 @@ "updated_at" ] }, + "scope": { + "description": "The scope of the membership. Currently, can only be `team`.", + "type": "string", + "enum": [ + "team" + ] + }, "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -776704,157 +776432,225 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "format": "uri" }, - "following_url": { + "received_events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri" }, - "gists_url": { + "repos_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri" + }, + "site_admin": { + "type": "boolean" }, "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "format": "uri-template" }, "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" ] }, - "events_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] }, - "type": { + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { "type": "string", - "examples": [ - "User" + "enum": [ + "open", + "closed", + "secret" ] }, - "site_admin": { - "type": "boolean" + "repositories_url": { + "type": "string", + "format": "uri" }, - "starred_at": { + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name", + "id" ] } }, "required": [ "action", - "changes", - "milestone", - "repository", - "sender" + "scope", + "member", + "sender", + "team", + "organization" ] } } @@ -776868,22 +776664,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "membership", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "milestone-opened": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -776948,13 +776744,13 @@ "content": { "application/json": { "schema": { - "title": "milestone opened event", + "title": "membership removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "opened" + "removed" ] }, "enterprise": { @@ -777072,133 +776868,44 @@ "node_id" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", + "member": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "closed_at": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "following_url": { + "type": "string", + "format": "uri-template" }, - "description": { - "type": [ - "string", - "null" - ] + "gists_url": { + "type": "string", + "format": "uri-template" }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -777207,35 +776914,45 @@ "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "repos_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "site_admin": { + "type": "boolean" }, - "updated_at": { + "starred_url": { "type": "string", - "format": "date-time" + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] }, "url": { "type": "string", @@ -777243,22 +776960,8 @@ } }, "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" + "login", + "id" ] }, "organization": { @@ -778829,276 +778532,15 @@ "updated_at" ] }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "milestone", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "milestone", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "org-block-blocked": { - "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "org_block blocked event", - "type": "object", - "properties": { - "action": { + "scope": { + "description": "The scope of the membership. Currently, can only be `team`.", "type": "string", "enum": [ - "blocked" + "team", + "organization" ] }, - "blocked_user": { + "sender": { "title": "User", "type": [ "object", @@ -779194,13 +778636,16 @@ "id" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { + "deleted": { + "type": "boolean" + }, "description": { - "description": "A short description of the enterprise.", + "description": "Description of the team", "type": [ "string", "null" @@ -779208,81 +778653,232 @@ }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], "format": "uri" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "description": "Unique identifier of the team", + "type": "integer" }, - "node_id": { + "members_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri-template" }, "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "description": "Name of the team", + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] + "node_id": { + "type": "string" }, - "created_at": { + "parent": { "type": [ - "string", + "object", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" ] }, - "avatar_url": { + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", "type": "string", "format": "uri" } }, "required": [ - "id", - "node_id", "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "id" ] + } + }, + "required": [ + "action", + "scope", + "member", + "sender", + "team", + "organization" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "membership", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "merge-group-checks-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string" }, "installation": { "title": "Simple Installation", @@ -779309,6 +778905,119 @@ "node_id" ] }, + "merge_group": { + "title": "MergeGroup", + "type": "object", + "properties": { + "head_sha": { + "description": "The SHA of the merge group.", + "type": "string" + }, + "head_ref": { + "description": "The full ref of the merge group.", + "type": "string" + }, + "base_sha": { + "description": "The SHA of the merge group's parent commit.", + "type": "string" + }, + "base_ref": { + "description": "The full ref of the branch the merge group will be merged into.", + "type": "string" + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + } + }, + "required": [ + "head_sha", + "head_ref", + "base_sha", + "base_ref", + "head_commit" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -781041,9 +780750,7 @@ }, "required": [ "action", - "blocked_user", - "organization", - "sender" + "merge_group" ] } } @@ -781057,22 +780764,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org-block", + "subcategory": "merge-group", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "org-block-unblocked": { + "meta-deleted": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -781137,109 +780842,13 @@ "content": { "application/json": { "schema": { - "title": "org_block unblocked event", + "title": "meta deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unblocked" - ] - }, - "blocked_user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "deleted" ] }, "enterprise": { @@ -781332,6 +780941,132 @@ "avatar_url" ] }, + "hook": { + "description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.", + "type": "object", + "properties": { + "active": { + "type": "boolean" + }, + "config": { + "type": "object", + "properties": { + "content_type": { + "type": "string", + "enum": [ + "json", + "form" + ] + }, + "insecure_ssl": { + "type": "string" + }, + "secret": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "content_type", + "insecure_ssl", + "url" + ] + }, + "created_at": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "*", + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "create", + "delete", + "deployment", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "meta", + "milestone", + "organization", + "org_block", + "package", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "pull_request_review_thread", + "push", + "registry_package", + "release", + "repository", + "repository_import", + "repository_vulnerability_alert", + "secret_scanning_alert", + "secret_scanning_alert_location", + "security_and_analysis", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_job", + "workflow_run", + "repository_dispatch", + "projects_v2_item" + ], + "minItems": 1 + } + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "name", + "active", + "events", + "config", + "updated_at", + "created_at" + ] + }, + "hook_id": { + "description": "The id of the modified webhook.", + "type": "integer" + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -781457,104 +781192,300 @@ ] }, "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "name": { - "type": "string", - "examples": [ - "MIT License" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "pull": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "triage": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "admin", + "pull", + "push" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -781714,897 +781645,363 @@ "type", "url" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" }, - "push": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "email": { + "description": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", + ], "examples": [ - "octocat" + "This your first repo!" ] }, - "id": { - "type": "integer", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", "examples": [ - 1 + "https://api.github.com/repos/octocat/Hello-World" ] }, - "node_id": { + "archive_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "avatar_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "blobs_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "url": { + "branches_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "html_url": { + "collaborators_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "followers_url": { + "comments_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "following_url": { + "commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "gists_url": { + "compare_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "starred_url": { + "contents_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "subscriptions_url": { + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "type": { + "git_commits_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "git_refs_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" }, "git_tags_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] }, "issue_events_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] }, "issues_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] }, "keys_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] }, "labels_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] }, "languages_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] }, "merges_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] }, "milestones_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, "notifications_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, "pulls_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, "releases_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] }, "statuses_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] }, "subscribers_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] }, "subscription_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] }, "tags_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, "teams_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] }, "trees_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] }, "hooks_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] }, "language": { - "type": "string" + "type": [ + "string", + "null" + ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { - "type": "integer" + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 0 + ] }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -782613,78 +782010,507 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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" + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, "created_at": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] }, - "permissions": { - "type": "object", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], "properties": { - "admin": { + "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" }, - "maintain": { + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { "type": "boolean" }, - "push": { + "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" }, - "triage": { + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { "type": "boolean" }, - "pull": { + "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" } } }, - "allow_rebase_merge": { - "type": "boolean" - }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { - "type": "boolean" + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "allow_auto_merge": { - "type": "boolean" + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, "allow_update_branch": { - "type": "boolean" + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, "use_squash_pr_title_as_default": { - "type": "boolean" + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -782721,6 +782547,20 @@ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, "subscribers_count": { @@ -782728,201 +782568,103 @@ }, "network_count": { "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] - }, - "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": { @@ -783089,9 +782831,8 @@ }, "required": [ "action", - "blocked_user", - "organization", - "sender" + "hook_id", + "hook" ] } } @@ -783105,22 +782846,24 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org-block", + "subcategory": "meta", "supported-webhook-types": [ - "organization", + "marketplace", "business", + "repository", + "organization", "app" ] } } }, - "organization-deleted": { + "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -783185,13 +782928,13 @@ "content": { "application/json": { "schema": { - "title": "organization deleted event", + "title": "milestone closed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "closed" ] }, "enterprise": { @@ -783309,26 +783052,26 @@ "node_id" ] }, - "membership": { - "title": "Membership", - "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "organization_url": { - "type": "string", - "format": "uri" - }, - "role": { - "type": "string" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "state": { - "type": "string" + "closed_issues": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -783411,7 +783154,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -783423,14 +783167,79 @@ "login", "id" ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", "state", - "role", - "organization_url", - "user" + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -785165,7 +784974,8 @@ }, "required": [ "action", - "organization", + "milestone", + "repository", "sender" ] } @@ -785180,22 +784990,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-member-added": { + "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -785260,13 +785070,13 @@ "content": { "application/json": { "schema": { - "title": "organization member_added event", + "title": "milestone created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "member_added" + "created" ] }, "enterprise": { @@ -785384,26 +785194,26 @@ "node_id" ] }, - "membership": { - "title": "Membership", - "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "organization_url": { - "type": "string", - "format": "uri" - }, - "role": { - "type": "string" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "state": { - "type": "string" + "closed_issues": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -785498,14 +785308,79 @@ "login", "id" ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", "state", - "role", - "organization_url", - "user" + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -787240,8 +787115,8 @@ }, "required": [ "action", - "membership", - "organization", + "milestone", + "repository", "sender" ] } @@ -787256,22 +787131,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-member-invited": { + "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -787336,13 +787211,13 @@ "content": { "application/json": { "schema": { - "title": "organization member_invited event", + "title": "milestone deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "member_invited" + "deleted" ] }, "enterprise": { @@ -787460,41 +787335,26 @@ "node_id" ] }, - "invitation": { - "description": "The invitation for the user or email if the action is `member_invited`.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "failed_at": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "failed_reason": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "number" + "closed_issues": { + "type": "integer" }, - "invitation_teams_url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "inviter": { + "creator": { "title": "User", "type": [ "object", @@ -787577,7 +787437,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -787590,34 +787451,78 @@ "id" ] }, - "login": { + "description": { "type": [ "string", "null" ] }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, "node_id": { "type": "string" }, - "role": { + "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" }, - "team_count": { - "type": "number" + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ + "url", + "html_url", + "labels_url", "id", "node_id", - "login", - "email", - "role", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", "created_at", - "failed_at", - "failed_reason", - "inviter", - "team_count", - "invitation_teams_url" + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -789348,108 +789253,12 @@ "type", "url" ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] } }, "required": [ "action", - "invitation", - "organization", + "milestone", + "repository", "sender" ] } @@ -789464,22 +789273,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-member-removed": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -789544,15 +789353,57 @@ "content": { "application/json": { "schema": { - "title": "organization member_removed event", + "title": "milestone edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "member_removed" + "edited" ] }, + "changes": { + "description": "The changes to the milestone if the action was `edited`.", + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the description if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "due_on": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the due date if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -789668,26 +789519,26 @@ "node_id" ] }, - "membership": { - "title": "Membership", - "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "organization_url": { - "type": "string", - "format": "uri" - }, - "role": { - "type": "string" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "state": { - "type": "string" + "closed_issues": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -789770,7 +789621,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -789782,14 +789634,79 @@ "login", "id" ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", "state", - "role", - "organization_url", - "user" + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -791524,8 +791441,9 @@ }, "required": [ "action", - "membership", - "organization", + "changes", + "milestone", + "repository", "sender" ] } @@ -791540,22 +791458,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-renamed": { + "milestone-opened": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -791620,28 +791538,15 @@ "content": { "application/json": { "schema": { - "title": "organization renamed event", + "title": "milestone opened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "renamed" + "opened" ] }, - "changes": { - "type": "object", - "properties": { - "login": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -791757,26 +791662,26 @@ "node_id" ] }, - "membership": { - "title": "Membership", - "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "organization_url": { - "type": "string", - "format": "uri" - }, - "role": { - "type": "string" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "state": { - "type": "string" + "closed_issues": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -791871,14 +791776,79 @@ "login", "id" ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", "state", - "role", - "organization_url", - "user" + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -793613,7 +793583,8 @@ }, "required": [ "action", - "organization", + "milestone", + "repository", "sender" ] } @@ -793628,22 +793599,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "package-published": { + "org-block-blocked": { "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.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block" }, "parameters": [ { @@ -793708,13 +793679,109 @@ "content": { "application/json": { "schema": { - "title": "package published event", + "title": "org_block blocked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "blocked" + ] + }, + "blocked_user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, "enterprise": { @@ -793931,841 +793998,6 @@ "description" ] }, - "package": { - "description": "Information about the package.", - "type": "object", - "properties": { - "created_at": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "package_type": { - "type": "string" - }, - "package_version": { - "type": [ - "object", - "null" - ], - "properties": { - "author": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "body": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "body_html": { - "type": "string" - }, - "container_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "labels": { - "type": [ - "object", - "null" - ] - }, - "manifest": { - "type": [ - "object", - "null" - ] - }, - "tag": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - } - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" - }, - "npm_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - }, - "npm_user": { - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ] - }, - "bugs": { - "type": [ - "object", - "null" - ] - }, - "dependencies": { - "type": "object" - }, - "dev_dependencies": { - "type": "object" - }, - "peer_dependencies": { - "type": "object" - }, - "optional_dependencies": { - "type": "object" - }, - "description": { - "type": "string" - }, - "dist": { - "type": [ - "object", - "null" - ] - }, - "git_head": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "license": { - "type": "string" - }, - "main": { - "type": "string" - }, - "repository": { - "type": [ - "object", - "null" - ] - }, - "scripts": { - "type": "object" - }, - "id": { - "type": "string" - }, - "node_version": { - "type": "string" - }, - "npm_version": { - "type": "string" - }, - "has_shrinkwrap": { - "type": "boolean" - }, - "maintainers": { - "type": "array", - "items": { - "type": "object" - } - }, - "contributors": { - "type": "array", - "items": { - "type": "object" - } - }, - "engines": { - "type": "object" - }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } - }, - "files": { - "type": "array", - "items": { - "type": "string" - } - }, - "bin": { - "type": "object" - }, - "man": { - "type": "object" - }, - "directories": { - "type": [ - "object", - "null" - ] - }, - "os": { - "type": "array", - "items": { - "type": "string" - } - }, - "cpu": { - "type": "array", - "items": { - "type": "string" - } - }, - "readme": { - "type": "string" - }, - "installation_command": { - "type": "string" - }, - "release_id": { - "type": "integer" - }, - "commit_oid": { - "type": "string" - }, - "published_via_actions": { - "type": "boolean" - }, - "deleted_by_id": { - "type": "integer" - } - } - }, - "nuget_metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - }, - "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", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "state": { - "type": [ - "string", - "null" - ] - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "download_url", - "id", - "name", - "sha256", - "sha1", - "md5", - "content_type", - "state", - "size", - "created_at", - "updated_at" - ] - } - }, - "package_url": { - "type": "string" - }, - "prerelease": { - "type": "boolean" - }, - "release": { - "type": "object", - "properties": { - "author": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "created_at": { - "type": "string" - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "prerelease": { - "type": "boolean" - }, - "published_at": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "created_at", - "published_at" - ] - }, - "rubygems_metadata": { - "type": "array", - "items": { - } - }, - "source_url": { - "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", - "summary", - "name", - "description", - "html_url", - "metadata", - "package_files", - "installation_command" - ] - }, - "registry": { - "type": [ - "object", - "null" - ], - "properties": { - "about_url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "vendor": { - "type": "string" - } - }, - "required": [ - "about_url", - "name", - "type", - "url", - "vendor" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", - "html_url", - "created_at", - "updated_at", - "owner", - "package_version", - "registry" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -796399,7 +795631,8 @@ }, "required": [ "action", - "package", + "blocked_user", + "organization", "sender" ] } @@ -796414,22 +795647,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "org-block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "package-updated": { + "org-block-unblocked": { "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.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block" }, "parameters": [ { @@ -796494,13 +795727,109 @@ "content": { "application/json": { "schema": { - "title": "package updated event", + "title": "org_block unblocked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "updated" + "unblocked" + ] + }, + "blocked_user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, "enterprise": { @@ -796717,585 +796046,6 @@ "description" ] }, - "package": { - "description": "Information about the package.", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "package_type": { - "type": "string" - }, - "package_version": { - "type": "object", - "properties": { - "author": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "body": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - } - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - } - }, - "name": { - "type": "string" - }, - "package_files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "download_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "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": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "created_at": { - "type": "string" - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "prerelease": { - "type": "boolean" - }, - "published_at": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "created_at", - "published_at" - ] - }, - "rubygems_metadata": { - "type": "array", - "items": { - } - }, - "source_url": { - "type": "string", - "format": "uri" - }, - "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", - "summary", - "name", - "description", - "body", - "body_html", - "html_url", - "target_commitish", - "target_oid", - "created_at", - "updated_at", - "metadata", - "package_files", - "author", - "installation_command" - ] - }, - "registry": { - "type": [ - "object", - "null" - ], - "properties": { - "about_url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "vendor": { - "type": "string" - } - }, - "required": [ - "about_url", - "name", - "type", - "url", - "vendor" - ] - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", - "html_url", - "created_at", - "updated_at", - "owner", - "package_version", - "registry" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -798929,8 +797679,8 @@ }, "required": [ "action", - "package", - "repository", + "blocked_user", + "organization", "sender" ] } @@ -798945,22 +797695,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "org-block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "package-v2-create": { + "organization-deleted": { "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.", - "description": "A package was created.", - "operationId": "package-v2/create", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package-v2" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -799025,12 +797775,13 @@ "content": { "application/json": { "schema": { + "title": "organization deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "deleted" ] }, "enterprise": { @@ -799148,6 +797899,130 @@ "node_id" ] }, + "membership": { + "title": "Membership", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "type": "object", + "properties": { + "organization_url": { + "type": "string", + "format": "uri" + }, + "role": { + "type": "string" + }, + "state": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "state", + "role", + "organization_url", + "user" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -799247,232 +798122,6 @@ "description" ] }, - "package": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "ecosystem": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "package_version": { - "type": "object", - "properties": { - "blob_store": { - "type": "string" - }, - "container_metadata": { - "type": "object", - "properties": { - "labels": { - "type": "object", - "properties": { - "all_labels": { - "type": "object", - "properties": { - "com.github.base_image.id": { - "type": "string" - }, - "com.github.base_image.repo_digest": { - "type": "string" - }, - "com.github.repo.branch": { - "type": "string" - }, - "ghes.licenses.path": { - "type": "string" - }, - "org.opencontainers.image.created": { - "type": "string" - }, - "org.opencontainers.image.description": { - "type": "string" - }, - "org.opencontainers.image.documentation": { - "type": "string" - }, - "org.opencontainers.image.revision": { - "type": "string" - }, - "org.opencontainers.image.source": { - "type": "string" - } - } - }, - "description": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "licenses": { - "type": "string" - }, - "revision": { - "type": "string" - }, - "source": { - "type": "string" - } - }, - "required": [ - "description", - "source", - "revision", - "image_url", - "licenses", - "all_labels" - ] - }, - "manifest": { - "type": "object", - "properties": { - "config": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "media_type": { - "type": "string" - }, - "size": { - "type": "integer" - } - }, - "required": [ - "digest", - "media_type", - "size" - ] - }, - "digest": { - "type": "string" - }, - "layers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "media_type": { - "type": "string" - }, - "size": { - "type": "integer" - } - }, - "required": [ - "digest", - "media_type", - "size" - ] - } - }, - "media_type": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "uri": { - "type": "string" - } - }, - "required": [ - "digest", - "media_type", - "uri", - "size", - "config", - "layers" - ] - }, - "tag": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "name", - "digest" - ] - } - }, - "required": [ - "tag", - "labels", - "manifest" - ] - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "description", - "blob_store", - "html_url", - "created_at", - "updated_at" - ] - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "namespace", - "description", - "ecosystem", - "html_url", - "created_at", - "updated_at", - "package_version" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -801106,7 +799755,6 @@ }, "required": [ "action", - "package", "organization", "sender" ] @@ -801122,21 +799770,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package-v2", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "page-build": { + "organization-member-added": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#page-build" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -801201,155 +799850,13 @@ "content": { "application/json": { "schema": { - "title": "page_build event", + "title": "organization member_added event", "type": "object", "properties": { - "build": { - "description": "The [List GitHub Pages builds](https://docs.github.com/rest/reference/repos#list-github-pages-builds) itself.", - "type": "object", - "properties": { - "commit": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "duration": { - "type": "integer" - }, - "error": { - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "message" - ] - }, - "pusher": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "status": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "status", - "error", - "pusher", - "commit", - "duration", - "created_at", - "updated_at" + "action": { + "type": "string", + "enum": [ + "member_added" ] }, "enterprise": { @@ -801442,9 +799949,6 @@ "avatar_url" ] }, - "id": { - "type": "integer" - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -801470,6 +799974,130 @@ "node_id" ] }, + "membership": { + "title": "Membership", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "type": "object", + "properties": { + "organization_url": { + "type": "string", + "format": "uri" + }, + "role": { + "type": "string" + }, + "state": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "state", + "role", + "organization_url", + "user" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -803201,9 +801829,9 @@ } }, "required": [ - "id", - "build", - "repository", + "action", + "membership", + "organization", "sender" ] } @@ -803218,21 +801846,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page-build", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "ping": { + "organization-member-invited": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -803297,152 +801926,290 @@ "content": { "application/json": { "schema": { + "title": "organization member_invited event", "type": "object", "properties": { - "hook": { - "title": "Webhook", - "description": "The webhook that is being pinged", + "action": { + "type": "string", + "enum": [ + "member_invited" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "active": { - "description": "Determines whether the hook is actually triggered for the events it subscribes to.", - "type": "boolean" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "app_id": { - "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.", - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "config": { - "type": "object", - "properties": { - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - } - } + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "created_at": { + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "format": "date-time" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "deliveries_url": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "invitation": { + "description": "The invitation for the user or email if the action is `member_invited`.", + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "failed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "failed_reason": { + "type": [ + "string", + "null" + ] }, "id": { - "description": "Unique identifier of the webhook.", - "type": "integer" + "type": "number" }, - "last_response": { - "title": "Hook Response", - "type": "object", + "invitation_teams_url": { + "type": "string", + "format": "uri" + }, + "inviter": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "code": { - "type": [ - "integer", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" }, - "status": { + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "message": { - "type": [ - "string", - "null" + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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": [ - "code", - "status", - "message" + "login", + "id" ] }, - "name": { - "description": "The type of webhook. The only valid value is 'web'.", - "type": "string", - "enum": [ - "web" + "login": { + "type": [ + "string", + "null" ] }, - "ping_url": { - "type": "string", - "format": "uri" - }, - "test_url": { - "type": "string", - "format": "uri" - }, - "type": { + "node_id": { "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "role": { + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "team_count": { + "type": "number" } }, "required": [ "id", - "type", - "name", - "active", - "events", - "config", + "node_id", + "login", + "email", + "role", "created_at", - "updated_at" + "failed_at", + "failed_reason", + "inviter", + "team_count", + "invitation_teams_url" ] }, - "hook_id": { - "description": "The ID of the webhook that triggered the ping.", - "type": "integer" - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -805172,179 +803939,109 @@ "url" ] }, - "zen": { - "description": "Random string of GitHub zen.", - "type": "string" - } - } - }, - "examples": { - "default": { - "value": { - "zen": "Anything added dilutes everything else.", - "hook_id": 109948940, - "hook": { - "type": "Repository", - "id": 109948940, - "name": "web", - "active": true, - "events": [ - "*" - ], - "config": { - "content_type": "json", - "url": "https://smee.io/****************", - "insecure_ssl": "0" + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "updated_at": "2019-05-15T15:20:49Z", - "created_at": "2019-05-15T15:20:49Z", - "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940", - "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test", - "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - }, - "repository": { - "id": 186853261, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", - "name": "Hello-World", - "full_name": "Octocoders/Hello-World", - "private": false, - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false + "deleted": { + "type": "boolean" }, - "html_url": "https://github.com/Octocoders/Hello-World", - "description": null, - "fork": true, - "url": "https://api.github.com/repos/Octocoders/Hello-World", - "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", - "created_at": "2019-05-15T15:20:42Z", - "updated_at": "2019-05-15T15:20:45Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Octocoders/Hello-World.git", - "ssh_url": "git@github.com:Octocoders/Hello-World.git", - "clone_url": "https://github.com/Octocoders/Hello-World.git", - "svn_url": "https://github.com/Octocoders/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": false, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master" + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "description": "The webhooks ping payload encoded with URL encoding.", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object.", - "type": "string" + "required": [ + "login", + "id" + ] } }, "required": [ - "payload" + "action", + "invitation", + "organization", + "sender" ] - }, - "examples": { - "default": { - "value": { - "payload": "%7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D" - } - } } } } @@ -805356,26 +804053,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", - "app", "business", - "marketplace" + "app" ] } } }, - "project-card-converted": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a classic project was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -805440,32 +804134,13 @@ "content": { "application/json": { "schema": { - "title": "project_card converted event", + "title": "organization member_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "converted" - ] - }, - "changes": { - "type": "object", - "properties": { - "note": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "note" + "member_removed" ] }, "enterprise": { @@ -805583,135 +804258,26 @@ "node_id" ] }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "membership": { + "title": "Membership", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", "type": "object", "properties": { - "login": { + "organization_url": { "type": "string", - "examples": [ - "github" - ] + "format": "uri" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "role": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] + "state": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "project_card": { - "title": "Project Card", - "type": "object", - "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_id": { - "type": "integer" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { "type": "string", "format": "uri" }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "user": { "title": "User", "type": [ "object", @@ -805806,45 +804372,113 @@ "login", "id" ] + } + }, + "required": [ + "url", + "state", + "role", + "organization_url", + "user" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] }, "id": { - "description": "The project card's ID", - "type": "integer" + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] }, - "note": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" ] }, - "project_url": { + "repos_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "url": { + "hooks_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] } }, "required": [ + "login", "url", - "project_url", - "column_url", - "column_id", "id", "node_id", - "note", - "archived", - "creator", - "created_at", - "updated_at" + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, "repository": { @@ -807480,8 +806114,8 @@ }, "required": [ "action", - "changes", - "project_card", + "membership", + "organization", "sender" ] } @@ -807496,22 +806130,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-card", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "project-card-created": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a classic project.", - "operationId": "project-card/created", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -807576,15 +806210,28 @@ "content": { "application/json": { "schema": { - "title": "project_card created event", + "title": "organization renamed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "renamed" ] }, + "changes": { + "type": "object", + "properties": { + "login": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -807700,135 +806347,26 @@ "node_id" ] }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "membership": { + "title": "Membership", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", "type": "object", "properties": { - "login": { + "organization_url": { "type": "string", - "examples": [ - "github" - ] + "format": "uri" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "role": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] + "state": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "project_card": { - "title": "Project Card", - "type": "object", - "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_id": { - "type": "integer" - }, - "column_url": { "type": "string", "format": "uri" }, - "content_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "user": { "title": "User", "type": [ "object", @@ -807923,45 +806461,113 @@ "login", "id" ] + } + }, + "required": [ + "url", + "state", + "role", + "organization_url", + "user" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] }, "id": { - "description": "The project card's ID", - "type": "integer" + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] }, - "note": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" ] }, - "project_url": { + "repos_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "url": { + "hooks_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] } }, "required": [ + "login", "url", - "project_url", - "column_url", - "column_id", "id", "node_id", - "note", - "archived", - "creator", - "created_at", - "updated_at" + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, "repository": { @@ -809597,7 +808203,7 @@ }, "required": [ "action", - "project_card", + "organization", "sender" ] } @@ -809612,22 +808218,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-card", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "project-card-deleted": { + "package-published": { "post": { - "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a classic project was deleted.", - "operationId": "project-card/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.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -809692,13 +808298,13 @@ "content": { "application/json": { "schema": { - "title": "project_card deleted event", + "title": "package published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "published" ] }, "enterprise": { @@ -809915,39 +808521,39 @@ "description" ] }, - "project_card": { - "title": "Project Card", + "package": { + "description": "Information about the package.", "type": "object", "properties": { - "after_id": { + "created_at": { "type": [ - "integer", + "string", "null" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_id": { + "description": { "type": [ - "integer", + "string", "null" ] }, - "column_url": { - "type": "string", - "format": "uri" + "ecosystem": { + "type": "string" }, - "content_url": { + "html_url": { "type": "string", "format": "uri" }, - "created_at": { - "type": "string", - "format": "date-time" + "id": { + "type": "integer" }, - "creator": { + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -810030,8 +808636,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -810044,159 +808649,487 @@ "id" ] }, - "id": { - "description": "The project card's ID", - "type": "integer" - }, - "node_id": { + "package_type": { "type": "string" }, - "note": { + "package_version": { "type": [ - "string", + "object", "null" - ] - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "column_url", - "column_id", - "id", - "node_id", - "note", - "archived", - "creator", - "created_at", - "updated_at" - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", + ], "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "author": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } ] }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "body_html": { + "type": "string" }, - "license": { - "anyOf": [ - { - "type": "null" + "container_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "labels": { + "type": [ + "object", + "null" + ] }, - { - "title": "License Simple", - "description": "License Simple", + "manifest": { + "type": [ + "object", + "null" + ] + }, + "tag": { "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "digest": { + "type": "string" }, "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" + "type": "string" } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + } + } + } + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "npm_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "type": [ + "object", + "null" + ] + }, + "bugs": { + "type": [ + "object", + "null" + ] + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "type": [ + "object", + "null" + ] + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "type": [ + "object", + "null" + ] + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "object" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "object" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "type": [ + "object", + "null" ] + }, + "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" } - ] + } }, - "organization": { - "anyOf": [ - { - "type": "null" + "nuget_metadata": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "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", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "state": { + "type": [ + "string", + "null" + ] + }, + "updated_at": { + "type": "string" + } }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "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": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -810204,181 +809137,324 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, "type": { "type": "string", - "examples": [ - "User" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": [ + "string", + "null" ] + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" ] }, - "forks": { - "type": "integer" + "rubygems_metadata": { + "type": "array", + "items": { + } }, - "permissions": { + "source_url": { + "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", + "summary", + "name", + "description", + "html_url", + "metadata", + "package_files", + "installation_command" + ] + }, + "registry": { + "type": [ + "object", + "null" + ], + "properties": { + "about_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "vendor": { + "type": "string" + } + }, + "required": [ + "about_url", + "name", + "type", + "url", + "vendor" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "admin": { - "type": "boolean" + "key": { + "type": "string", + "examples": [ + "mit" + ] }, - "pull": { - "type": "boolean" + "name": { + "type": "string", + "examples": [ + "MIT License" + ] }, - "triage": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "push": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "maintain": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -810538,363 +809614,897 @@ "type", "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, + "pull": { "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "triage": { + "type": "boolean" }, - "description": { + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "octocat" ] }, - "archive_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + 1 ] }, - "assignees_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "MDQ6VXNlcjE=" ] }, - "blobs_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "branches_url": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat" ] }, - "collaborators_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://github.com/octocat" ] }, - "comments_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/followers" ] }, - "commits_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "forks_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/received_events" ] }, - "git_commits_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "User" ] }, - "git_refs_url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "\"2020-07-09T00:17:55Z\"" ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" }, "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "type": "string" }, "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "type": "string" }, "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] + "type": "string" }, "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] + "type": "string" }, "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] + "type": "string" }, "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "type": "string" }, "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] + "type": "string" }, "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] + "type": "string" }, "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] + "type": "string" }, "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] + "type": "string" }, "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "type": "string" }, "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] + "type": "string" }, "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "type": "string" }, "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] + "type": "string" }, "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] + "type": "string" }, "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] + "type": "string" }, "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] + "type": "string" }, "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] + "type": "string" }, "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "type": "string" }, "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] + "type": "string" }, "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "type": "string" }, "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] + "type": "string" }, "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] + "type": "string" }, "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "type": "string" }, "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] + "type": "string" }, "language": { - "type": [ - "string", - "null" - ] + "type": "string" }, "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "type": "integer" }, "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "type": "string" }, "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "topics": { "type": "array", @@ -810903,507 +810513,78 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "type": "string" }, "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "type": "string" }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "string" }, - "template_repository": { - "type": [ - "object", - "null" - ], + "permissions": { + "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": { + "admin": { "type": "boolean" }, - "delete_branch_on_merge": { + "maintain": { "type": "boolean" }, - "allow_update_branch": { + "push": { "type": "boolean" }, - "use_squash_pr_title_as_default": { + "triage": { "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": { + "pull": { "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" } } }, + "allow_rebase_merge": { + "type": "boolean" + }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true + "type": "boolean" }, "squash_merge_commit_title": { "type": "string", @@ -811440,20 +810621,6 @@ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, "type": "boolean" }, "subscribers_count": { @@ -811461,103 +810628,201 @@ }, "network_count": { "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, "sender": { @@ -811724,7 +810989,7 @@ }, "required": [ "action", - "project_card", + "package", "sender" ] } @@ -811739,7 +811004,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-card", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -811748,13 +811013,13 @@ } } }, - "project-card-edited": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a classic project was edited.", - "operationId": "project-card/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.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -811819,35 +811084,13 @@ "content": { "application/json": { "schema": { - "title": "project_card edited event", + "title": "package updated event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" - ] - }, - "changes": { - "type": "object", - "properties": { - "note": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "note" + "updated" ] }, "enterprise": { @@ -812064,36 +811307,36 @@ "description" ] }, - "project_card": { - "title": "Project Card", + "package": { + "description": "Information about the package.", "type": "object", "properties": { - "after_id": { + "created_at": { + "type": "string" + }, + "description": { "type": [ - "integer", + "string", "null" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_id": { - "type": "integer" + "ecosystem": { + "type": "string" }, - "column_url": { + "html_url": { "type": "string", "format": "uri" }, - "content_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer" }, - "created_at": { - "type": "string", - "format": "date-time" + "name": { + "type": "string" }, - "creator": { + "namespace": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -812189,44 +811432,458 @@ "id" ] }, - "id": { - "description": "The project card's ID", - "type": "integer" - }, - "node_id": { + "package_type": { "type": "string" }, - "note": { + "package_version": { + "type": "object", + "properties": { + "author": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "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": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + } + }, + "source_url": { + "type": "string", + "format": "uri" + }, + "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", + "summary", + "name", + "description", + "body", + "body_html", + "html_url", + "target_commitish", + "target_oid", + "created_at", + "updated_at", + "metadata", + "package_files", + "author", + "installation_command" + ] + }, + "registry": { "type": [ - "string", + "object", "null" + ], + "properties": { + "about_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "vendor": { + "type": "string" + } + }, + "required": [ + "about_url", + "name", + "type", + "url", + "vendor" ] }, - "project_url": { - "type": "string", - "format": "uri" - }, "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" + "type": "string" } }, "required": [ - "url", - "project_url", - "column_url", - "column_id", "id", - "node_id", - "note", - "archived", - "creator", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", "created_at", - "updated_at" + "updated_at", + "owner", + "package_version", + "registry" ] }, "repository": { @@ -813862,8 +813519,8 @@ }, "required": [ "action", - "changes", - "project_card", + "package", + "repository", "sender" ] } @@ -813878,7 +813535,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-card", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -813887,13 +813544,13 @@ } } }, - "project-card-moved": { + "package-v2-create": { "post": { - "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a classic project was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "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.", + "description": "A package was created.", + "operationId": "package-v2/create", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package-v2" }, "parameters": [ { @@ -813958,32 +813615,12 @@ "content": { "application/json": { "schema": { - "title": "project_card moved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "moved" - ] - }, - "changes": { - "type": "object", - "properties": { - "column_id": { - "type": "object", - "properties": { - "from": { - "type": "integer" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "column_id" + "create" ] }, "enterprise": { @@ -814200,283 +813837,230 @@ "description" ] }, - "project_card": { - "allOf": [ - { - "title": "Project Card", + "package": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "package_version": { "type": "object", "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_id": { - "type": "integer" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" + "blob_store": { + "type": "string" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "container_metadata": { + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "labels": { + "type": "object", + "properties": { + "all_labels": { + "type": "object", + "properties": { + "com.github.base_image.id": { + "type": "string" + }, + "com.github.base_image.repo_digest": { + "type": "string" + }, + "com.github.repo.branch": { + "type": "string" + }, + "ghes.licenses.path": { + "type": "string" + }, + "org.opencontainers.image.created": { + "type": "string" + }, + "org.opencontainers.image.description": { + "type": "string" + }, + "org.opencontainers.image.documentation": { + "type": "string" + }, + "org.opencontainers.image.revision": { + "type": "string" + }, + "org.opencontainers.image.source": { + "type": "string" + } + } + }, + "description": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "licenses": { + "type": "string" + }, + "revision": { + "type": "string" + }, + "source": { + "type": "string" + } + }, + "required": [ + "description", + "source", + "revision", + "image_url", + "licenses", + "all_labels" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "manifest": { + "type": "object", + "properties": { + "config": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "media_type": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "required": [ + "digest", + "media_type", + "size" + ] + }, + "digest": { + "type": "string" + }, + "layers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "media_type": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "required": [ + "digest", + "media_type", + "size" + ] + } + }, + "media_type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "uri": { + "type": "string" + } + }, + "required": [ + "digest", + "media_type", + "uri", + "size", + "config", + "layers" ] }, - "url": { - "type": "string", - "format": "uri" + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "name", + "digest" + ] } }, "required": [ - "login", - "id" + "tag", + "labels", + "manifest" ] }, - "id": { - "description": "The project card's ID", - "type": "integer" - }, - "node_id": { + "created_at": { "type": "string" }, - "note": { - "type": [ - "string", - "null" - ] - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "column_url", - "column_id", - "id", - "node_id", - "note", - "archived", - "creator", - "created_at", - "updated_at" - ] - }, - { - "type": "object", - "properties": { - "after_id": { - "type": [ - "number", - "null" - ] - }, - "archived": { - "type": "boolean" - }, - "column_id": { - "type": "integer" - }, - "column_url": { + "description": { "type": "string" }, - "created_at": { + "html_url": { "type": "string" }, - "creator": { - "type": [ - "object", - "null" - ], - "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" - } - } - }, "id": { "type": "integer" }, - "node_id": { - "type": "string" - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "project_url": { + "name": { "type": "string" }, "updated_at": { "type": "string" - }, - "url": { - "type": "string" } }, "required": [ - "after_id" + "id", + "name", + "description", + "blob_store", + "html_url", + "created_at", + "updated_at" ] + }, + "updated_at": { + "type": "string" } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "html_url", + "created_at", + "updated_at", + "package_version" ] }, "repository": { @@ -816112,7 +815696,8 @@ }, "required": [ "action", - "project_card", + "package", + "organization", "sender" ] } @@ -816127,7 +815712,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-card", + "subcategory": "package-v2", "supported-webhook-types": [ "repository", "organization", @@ -816136,13 +815721,12 @@ } } }, - "project-closed": { + "page-build": { "post": { - "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#page-build" }, "parameters": [ { @@ -816207,13 +815791,155 @@ "content": { "application/json": { "schema": { - "title": "project closed event", + "title": "page_build event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "closed" + "build": { + "description": "The [List GitHub Pages builds](https://docs.github.com/rest/reference/repos#list-github-pages-builds) itself.", + "type": "object", + "properties": { + "commit": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "duration": { + "type": "integer" + }, + "error": { + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "message" + ] + }, + "pusher": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "status", + "error", + "pusher", + "commit", + "duration", + "created_at", + "updated_at" ] }, "enterprise": { @@ -816306,6 +816032,9 @@ "avatar_url" ] }, + "id": { + "type": "integer" + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -816430,175 +816159,6 @@ "description" ] }, - "project": { - "title": "Project", - "type": "object", - "properties": { - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "owner_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -818231,8 +817791,9 @@ } }, "required": [ - "action", - "project", + "id", + "build", + "repository", "sender" ] } @@ -818247,7 +817808,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "page-build", "supported-webhook-types": [ "repository", "organization", @@ -818256,13 +817817,12 @@ } } }, - "project-column-created": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a classic project.", - "operationId": "project-column/created", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -818327,129 +817887,151 @@ "content": { "application/json": { "schema": { - "title": "project_column created event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "hook": { + "title": "Webhook", + "description": "The webhook that is being pinged", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + "active": { + "description": "Determines whether the hook is actually triggered for the events it subscribes to.", + "type": "boolean" }, - "html_url": { + "app_id": { + "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.", + "type": "integer" + }, + "config": { + "type": "object", + "properties": { + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + } + } + }, + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] + "format": "date-time" }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], + "deliveries_url": { + "type": "string", "format": "uri" }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + } + }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "description": "Unique identifier of the webhook.", + "type": "integer" }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "code", + "status", + "message" ] }, "name": { - "description": "The name of the enterprise.", + "description": "The type of webhook. The only valid value is 'web'.", "type": "string", - "examples": [ - "Octo Business" + "enum": [ + "web" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "ping_url": { "type": "string", - "examples": [ - "octo-business" - ] + "format": "uri" }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "test_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "type": "string", + "format": "date-time" }, - "avatar_url": { + "url": { "type": "string", "format": "uri" } }, "required": [ "id", - "node_id", + "type", "name", - "slug", - "html_url", + "active", + "events", + "config", "created_at", - "updated_at", - "avatar_url" + "updated_at" ] }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] + "hook_id": { + "description": "The ID of the webhook that triggered the ping.", + "type": "integer" }, "organization": { "title": "Organization Simple", @@ -818550,59 +818132,6 @@ "description" ] }, - "project_column": { - "title": "Project Column", - "type": "object", - "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "cards_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer" - }, - "name": { - "description": "Name of the project column", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "cards_url", - "id", - "node_id", - "name", - "created_at", - "updated_at" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -820232,12 +819761,180 @@ "type", "url" ] + }, + "zen": { + "description": "Random string of GitHub zen.", + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "zen": "Anything added dilutes everything else.", + "hook_id": 109948940, + "hook": { + "type": "Repository", + "id": 109948940, + "name": "web", + "active": true, + "events": [ + "*" + ], + "config": { + "content_type": "json", + "url": "https://smee.io/****************", + "insecure_ssl": "0" + }, + "updated_at": "2019-05-15T15:20:49Z", + "created_at": "2019-05-15T15:20:49Z", + "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940", + "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test", + "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + }, + "repository": { + "id": 186853261, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", + "name": "Hello-World", + "full_name": "Octocoders/Hello-World", + "private": false, + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "html_url": "https://github.com/Octocoders/Hello-World", + "description": null, + "fork": true, + "url": "https://api.github.com/repos/Octocoders/Hello-World", + "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T15:20:42Z", + "updated_at": "2019-05-15T15:20:45Z", + "pushed_at": "2019-05-15T15:20:33Z", + "git_url": "git://github.com/Octocoders/Hello-World.git", + "ssh_url": "git@github.com:Octocoders/Hello-World.git", + "clone_url": "https://github.com/Octocoders/Hello-World.git", + "svn_url": "https://github.com/Octocoders/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": false, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 0, + "license": null, + "forks": 0, + "open_issues": 0, + "watchers": 0, + "default_branch": "master" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "description": "The webhooks ping payload encoded with URL encoding.", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object.", + "type": "string" } }, "required": [ - "action", - "project_column" + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D" + } + } } } } @@ -820249,23 +819946,26 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project-column", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "project-column-deleted": { + "project-card-converted": { "post": { - "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a classic project.", - "operationId": "project-column/deleted", + "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a classic project was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, "parameters": [ { @@ -820330,13 +820030,32 @@ "content": { "application/json": { "schema": { - "title": "project_column deleted event", + "title": "project_card converted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "converted" + ] + }, + "changes": { + "type": "object", + "properties": { + "note": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "note" ] }, "enterprise": { @@ -820553,8 +820272,8 @@ "description" ] }, - "project_column": { - "title": "Project Column", + "project_card": { + "title": "Project Card", "type": "object", "properties": { "after_id": { @@ -820563,7 +820282,18 @@ "null" ] }, - "cards_url": { + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": "integer" + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { "type": "string", "format": "uri" }, @@ -820571,17 +820301,115 @@ "type": "string", "format": "date-time" }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, "id": { - "description": "The unique identifier of the project column", + "description": "The project card's ID", "type": "integer" }, - "name": { - "description": "Name of the project column", - "type": "string" - }, "node_id": { "type": "string" }, + "note": { + "type": [ + "string", + "null" + ] + }, "project_url": { "type": "string", "format": "uri" @@ -820598,309 +820426,116 @@ "required": [ "url", "project_url", - "cards_url", + "column_url", + "column_id", "id", "node_id", - "name", + "note", + "archived", + "creator", "created_at", "updated_at" ] }, "repository": { - "anyOf": [ - { - "type": "null" + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name": { + "type": "string", + "examples": [ + "MIT License" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "triage": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "push": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "maintain": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -821060,2200 +820695,370 @@ "type", "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, + "pull": { "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "triage": { + "type": "boolean" }, - "description": { + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "email": { + "type": [ + "string", + "null" ] }, - "deployments_url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "octocat" ] }, - "downloads_url": { - "type": "string", - "format": "uri", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + 1 ] }, - "events_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "MDQ6VXNlcjE=" ] }, - "forks_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "labels_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "languages_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/users/octocat" ] }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false + "https://api.github.com/users/octocat/received_events" ] }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. 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": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "User" ] }, - "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, + "site_admin": { "type": "boolean" }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "\"2020-07-09T00:17:55Z\"" ] - }, - "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", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "email": { + "description": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", + ], "examples": [ - "octocat" + "This your first repo!" ] }, - "id": { - "type": "integer", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", "examples": [ - 1 + "https://api.github.com/repos/octocat/Hello-World" ] }, - "node_id": { + "archive_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "avatar_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "blobs_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "url": { + "branches_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "html_url": { + "collaborators_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "followers_url": { + "comments_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "following_url": { + "commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "gists_url": { + "compare_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "starred_url": { + "contents_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "subscriptions_url": { + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "type": { + "git_commits_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "git_refs_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "project_column" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "project-column", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "project-column-edited": { - "post": { - "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a classic project was changed.", - "operationId": "project-column/edited", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "project_column edited event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" - ] - }, - "changes": { - "type": "object", - "properties": { - "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "html_url": { + "git_tags_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/enterprises/octo-business" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", + "git_url": { + "type": "string", "examples": [ - 42 + "git:github.com/octocat/Hello-World.git" ] }, - "node_id": { + "issue_comment_url": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "name": { - "description": "The name of the enterprise.", + "issue_events_url": { "type": "string", "examples": [ - "Octo Business" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "issues_url": { "type": "string", "examples": [ - "octo-business" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "keys_url": { + "type": "string", "examples": [ - "2019-01-26T19:01:12Z" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "labels_url": { + "type": "string", "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "project_column": { - "title": "Project Column", - "type": "object", - "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "cards_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer" - }, - "name": { - "description": "Name of the project column", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "cards_url", - "id", - "node_id", - "name", - "created_at", - "updated_at" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { @@ -824266,7 +822071,8 @@ "required": [ "action", "changes", - "project_column" + "project_card", + "sender" ] } } @@ -824280,7 +822086,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-column", + "subcategory": "project-card", "supported-webhook-types": [ "repository", "organization", @@ -824289,13 +822095,13 @@ } } }, - "project-column-moved": { + "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a classic project.", - "operationId": "project-column/moved", + "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a classic project.", + "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, "parameters": [ { @@ -824360,13 +822166,13 @@ "content": { "application/json": { "schema": { - "title": "project_column moved event", + "title": "project_card created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "moved" + "created" ] }, "enterprise": { @@ -824583,8 +822389,8 @@ "description" ] }, - "project_column": { - "title": "Project Column", + "project_card": { + "title": "Project Card", "type": "object", "properties": { "after_id": { @@ -824593,7 +822399,18 @@ "null" ] }, - "cards_url": { + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": "integer" + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { "type": "string", "format": "uri" }, @@ -824601,17 +822418,115 @@ "type": "string", "format": "date-time" }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, "id": { - "description": "The unique identifier of the project column", + "description": "The project card's ID", "type": "integer" }, - "name": { - "description": "Name of the project column", - "type": "string" - }, "node_id": { "type": "string" }, + "note": { + "type": [ + "string", + "null" + ] + }, "project_url": { "type": "string", "format": "uri" @@ -824628,10 +822543,13 @@ "required": [ "url", "project_url", - "cards_url", + "column_url", + "column_id", "id", "node_id", - "name", + "note", + "archived", + "creator", "created_at", "updated_at" ] @@ -826269,7 +824187,7 @@ }, "required": [ "action", - "project_column", + "project_card", "sender" ] } @@ -826284,7 +824202,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-column", + "subcategory": "project-card", "supported-webhook-types": [ "repository", "organization", @@ -826293,13 +824211,13 @@ } } }, - "project-created": { + "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a classic project was deleted.", + "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, "parameters": [ { @@ -826364,13 +824282,13 @@ "content": { "application/json": { "schema": { - "title": "project created event", + "title": "project_card deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "deleted" ] }, "enterprise": { @@ -826587,18 +824505,31 @@ "description" ] }, - "project": { - "title": "Project", + "project_card": { + "title": "Project Card", "type": "object", "properties": { - "body": { - "description": "Body of the project", + "after_id": { "type": [ - "string", + "integer", "null" ] }, - "columns_url": { + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": [ + "integer", + "null" + ] + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { "type": "string", "format": "uri" }, @@ -826689,7 +824620,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -826702,35 +824634,23 @@ "id" ] }, - "html_url": { - "type": "string", - "format": "uri" - }, "id": { + "description": "The project card's ID", "type": "integer" }, - "name": { - "description": "Name of the project", - "type": "string" - }, "node_id": { "type": "string" }, - "number": { - "type": "integer" + "note": { + "type": [ + "string", + "null" + ] }, - "owner_url": { + "project_url": { "type": "string", "format": "uri" }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, "updated_at": { "type": "string", "format": "date-time" @@ -826741,120 +824661,314 @@ } }, "required": [ - "owner_url", "url", - "html_url", - "columns_url", + "project_url", + "column_url", + "column_id", "id", "node_id", - "name", - "body", - "number", - "state", + "note", + "archived", "creator", "created_at", "updated_at" ] }, "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "name": { - "type": "string", - "examples": [ - "MIT License" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "pull": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "triage": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "admin", + "pull", + "push" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -827014,603 +825128,2552 @@ "type", "url" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" }, - "triage": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, - "push": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "email": { - "type": [ - "string", - "null" + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "login": { + "archive_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "id": { - "type": "integer", + "assignees_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "node_id": { + "blobs_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "avatar_url": { + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "description": { + "email": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" - }, - "url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "octocat" ] }, - "archive_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + 1 ] }, - "assignees_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "MDQ6VXNlcjE=" ] }, - "blobs_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "branches_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "collaborators_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/users/octocat" ] }, - "comments_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://github.com/octocat" ] }, - "commits_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/followers" ] }, - "compare_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "contents_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contributors_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "deployments_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/subscriptions" ] }, - "downloads_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/orgs" ] }, - "events_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/repos" ] }, - "forks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "git_commits_url": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_refs_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "User" ] }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "site_admin": { + "type": "boolean" }, - "git_url": { + "starred_at": { "type": "string", "examples": [ - "git:github.com/octocat/Hello-World.git" + "\"2020-07-09T00:17:55Z\"" ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "project_card", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project-card", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-card-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a classic project was edited.", + "operationId": "project-card/edited", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "project_card edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "note": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "from" ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + } + }, + "required": [ + "note" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" ] }, - "issues_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "https://github.com/enterprises/octo-business" ] }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "labels_url": { - "type": "string", + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 42 ] }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "merges_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "Octo Business" ] }, - "milestones_url": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "octo-business" ] }, - "notifications_url": { - "type": "string", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "2019-01-26T19:01:12Z" ] }, - "pulls_url": { - "type": "string", + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "2019-01-26T19:14:43Z" ] }, - "releases_url": { + "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. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + 1 ] }, - "ssh_url": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "git@github.com:octocat/Hello-World.git" + "MDQ6VXNlcjU4MzIzMQ==" ] - }, - "stargazers_url": { + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "github" ] }, - "statuses_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + 1 ] }, - "subscribers_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "subscription_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/orgs/github" ] }, - "tags_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/orgs/github/repos" ] }, - "teams_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/orgs/github/events" ] }, - "trees_url": { + "hooks_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/orgs/github/hooks" ] }, - "clone_url": { + "issues_url": { "type": "string", "examples": [ - "https://github.com/octocat/Hello-World.git" + "https://api.github.com/orgs/github/issues" ] }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", + "members_url": { + "type": "string", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/orgs/github/members{/member}" ] }, - "hooks_url": { + "public_members_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "svn_url": { + "avatar_url": { "type": "string", - "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "homepage": { + "description": { "type": [ "string", "null" ], - "format": "uri", "examples": [ - "https://github.com" + "A great organization" ] - }, - "language": { + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "project_card": { + "title": "Project Card", + "type": "object", + "properties": { + "after_id": { "type": [ - "string", + "integer", "null" ] }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "column_id": { + "type": "integer" }, - "default_branch": { - "description": "The default branch of the repository.", + "column_url": { "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "format": "uri" }, - "has_pages": { - "type": "boolean" + "content_url": { + "type": "string", + "format": "uri" }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "created_at": { + "type": "string", + "format": "date-time" }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": [ + "string", + "null" + ] + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { "description": "Whether the repository is archived.", @@ -828389,7 +828452,8 @@ }, "required": [ "action", - "project", + "changes", + "project_card", "sender" ] } @@ -828404,7 +828468,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project-card", "supported-webhook-types": [ "repository", "organization", @@ -828413,13 +828477,13 @@ } } }, - "project-deleted": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was deleted.", - "operationId": "project/deleted", + "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a classic project was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, "parameters": [ { @@ -828484,13 +828548,32 @@ "content": { "application/json": { "schema": { - "title": "project deleted event", + "title": "project_card moved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "moved" + ] + }, + "changes": { + "type": "object", + "properties": { + "column_id": { + "type": "object", + "properties": { + "from": { + "type": "integer" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "column_id" ] }, "enterprise": { @@ -828707,470 +828790,384 @@ "description" ] }, - "project": { - "title": "Project", - "type": "object", - "properties": { - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "project_card": { + "allOf": [ + { + "title": "Project Card", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "after_id": { "type": [ - "string", + "integer", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" }, - "followers_url": { + "column_id": { + "type": "integer" + }, + "column_url": { "type": "string", "format": "uri" }, - "following_url": { + "content_url": { "type": "string", - "format": "uri-template" + "format": "uri" }, - "gists_url": { + "created_at": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri" + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, "id": { + "description": "The project card's ID", "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, - "organizations_url": { + "note": { + "type": [ + "string", + "null" + ] + }, + "project_url": { "type": "string", "format": "uri" }, - "received_events_url": { + "updated_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "repos_url": { + "url": { "type": "string", "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + { + "type": "object", + "properties": { + "after_id": { + "type": [ + "number", + "null" + ] }, - "site_admin": { + "archived": { "type": "boolean" }, - "starred_url": { - "type": "string", - "format": "uri-template" + "column_id": { + "type": "integer" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "column_url": { + "type": "string" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "created_at": { + "type": "string" + }, + "creator": { + "type": [ + "object", + "null" + ], + "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" + } + } + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": [ + "string", + "null" ] }, + "project_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, "url": { - "type": "string", - "format": "uri" + "type": "string" } }, "required": [ - "login", - "id" + "after_id" ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, + } + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { - "type": "integer" - }, - "name": { - "description": "Name of the project", - "type": "string" + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "owner_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", "type": "string", - "enum": [ - "open", - "closed" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "updated_at": { + "name": { + "description": "The name of the repository.", "type": "string", - "format": "date-time" + "examples": [ + "Team Environment" + ] }, - "url": { + "full_name": { "type": "string", - "format": "uri" - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at" - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" + "examples": [ + "octocat/Hello-World" + ] }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "license": { + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name": { + "type": "string", + "examples": [ + "MIT License" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "triage": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "push": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "maintain": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -829330,363 +829327,897 @@ "type", "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, + "pull": { "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "triage": { + "type": "boolean" }, - "description": { + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "email": { + "type": [ + "string", + "null" ] }, - "contents_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "octocat" ] }, - "contributors_url": { - "type": "string", - "format": "uri", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + 1 ] }, - "deployments_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "MDQ6VXNlcjE=" ] }, - "downloads_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://github.com/images/error/octocat_happy.gif" ] }, - "events_url": { - "type": "string", - "format": "uri", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "41d064eb2195891e12d0413f63227ea7" ] }, - "forks_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "https://api.github.com/users/octocat" ] }, - "languages_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://github.com/octocat" ] }, - "merges_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://api.github.com/users/octocat/followers" ] }, - "pulls_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "releases_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "ssh_url": { + "starred_url": { "type": "string", "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "stargazers_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/subscriptions" ] }, - "subscribers_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/orgs" ] }, - "subscription_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/repos" ] }, - "tags_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "teams_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "clone_url": { + "type": { "type": "string", "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" + "User" ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] + "site_admin": { + "type": "boolean" }, - "svn_url": { + "starred_at": { "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" + "\"2020-07-09T00:17:55Z\"" ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" }, "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "type": "integer" }, "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "type": "string" }, "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "topics": { "type": "array", @@ -829695,507 +830226,78 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "type": "string" }, "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "type": "string" }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "string" }, - "template_repository": { - "type": [ - "object", - "null" - ], + "permissions": { + "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": { + "admin": { "type": "boolean" }, - "delete_branch_on_merge": { + "maintain": { "type": "boolean" }, - "allow_update_branch": { + "push": { "type": "boolean" }, - "use_squash_pr_title_as_default": { + "triage": { "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": { + "pull": { "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" } } }, + "allow_rebase_merge": { + "type": "boolean" + }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true + "type": "boolean" }, "squash_merge_commit_title": { "type": "string", @@ -830232,20 +830334,6 @@ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, "type": "boolean" }, "subscribers_count": { @@ -830253,103 +830341,201 @@ }, "network_count": { "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, "sender": { @@ -830516,7 +830702,8 @@ }, "required": [ "action", - "project" + "project_card", + "sender" ] } } @@ -830530,7 +830717,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project-card", "supported-webhook-types": [ "repository", "organization", @@ -830539,11 +830726,11 @@ } } }, - "project-edited": { + "project-closed": { "post": { "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a classic project was changed.", - "operationId": "project/edited", + "description": "A classic project was closed.", + "operationId": "project/closed", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, @@ -830610,45 +830797,15 @@ "content": { "application/json": { "schema": { - "title": "project edited event", + "title": "project closed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "closed" ] }, - "changes": { - "description": "The changes to the project if the action was `edited`.", - "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 changes to the project if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -832665,7 +832822,8 @@ }, "required": [ "action", - "project" + "project", + "sender" ] } } @@ -832688,13 +832846,13 @@ } } }, - "project-reopened": { + "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was closed.", - "operationId": "project/reopened", + "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a classic project.", + "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" }, "parameters": [ { @@ -832759,13 +832917,13 @@ "content": { "application/json": { "schema": { - "title": "project reopened event", + "title": "project_column created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "created" ] }, "enterprise": { @@ -832982,18 +833140,17 @@ "description" ] }, - "project": { - "title": "Project", + "project_column": { + "title": "Project Column", "type": "object", "properties": { - "body": { - "description": "Body of the project", + "after_id": { "type": [ - "string", + "integer", "null" ] }, - "columns_url": { + "cards_url": { "type": "string", "format": "uri" }, @@ -833001,131 +833158,21 @@ "type": "string", "format": "date-time" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, "id": { + "description": "The unique identifier of the project column", "type": "integer" }, "name": { - "description": "Name of the project", + "description": "Name of the project column", "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" - }, - "owner_url": { + "project_url": { "type": "string", "format": "uri" }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, "updated_at": { "type": "string", "format": "date-time" @@ -833136,17 +833183,12 @@ } }, "required": [ - "owner_url", "url", - "html_url", - "columns_url", + "project_url", + "cards_url", "id", "node_id", "name", - "body", - "number", - "state", - "creator", "created_at", "updated_at" ] @@ -834784,8 +834826,7 @@ }, "required": [ "action", - "project", - "sender" + "project_column" ] } } @@ -834799,7 +834840,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project-column", "supported-webhook-types": [ "repository", "organization", @@ -834808,13 +834849,13 @@ } } }, - "projects-v2-item-archived": { + "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a classic project.", + "operationId": "project-column/deleted", "externalDocs": { - "url": "" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" }, "parameters": [ { @@ -834836,7 +834877,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -834879,38 +834920,104 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Archived Event", + "title": "project_column deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "archived" + "deleted" ] }, - "changes": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "archived_at": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "to": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - } + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -835036,226 +835143,1533 @@ "description" ] }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", + "project_column": { + "title": "Project Column", "type": "object", "properties": { + "after_id": { + "type": [ + "integer", + "null" + ] + }, + "cards_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, "id": { - "type": "number" + "description": "The unique identifier of the project column", + "type": "integer" }, - "node_id": { + "name": { + "description": "Name of the project column", "type": "string" }, - "project_node_id": { + "node_id": { "type": "string" }, - "content_node_id": { - "type": "string" + "project_url": { + "type": "string", + "format": "uri" }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "updated_at": { "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] + "format": "date-time" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "cards_url", + "id", + "node_id", + "name", + "created_at", + "updated_at" + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": [ - "string", - "null" + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" ] }, - "email": { + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" + "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" ] } - }, - "required": [ - "id", - "content_node_id", - "content_type", - "created_at", - "updated_at", - "archived_at" ] }, "sender": { @@ -835422,10 +836836,7 @@ }, "required": [ "action", - "projects_v2_item", - "organization", - "sender", - "changes" + "project_column" ] } } @@ -835438,22 +836849,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project-column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-converted": { + "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a classic project was changed.", + "operationId": "project-column/edited", "externalDocs": { - "url": "" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" }, "parameters": [ { @@ -835475,7 +836887,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -835518,34 +836930,121 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Converted Event", + "title": "project_column edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "converted" + "edited" ] }, "changes": { "type": "object", "properties": { - "content_type": { + "name": { "type": "object", "properties": { "from": { - "type": [ - "string", - "null" - ] - }, - "to": { "type": "string" } - } + }, + "required": [ + "from" + ] } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -835670,34 +837169,349 @@ "description" ] }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", + "project_column": { + "title": "Project Column", "type": "object", "properties": { + "after_id": { + "type": [ + "integer", + "null" + ] + }, + "cards_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, "id": { - "type": "number" + "description": "The unique identifier of the project column", + "type": "integer" }, - "node_id": { + "name": { + "description": "Name of the project column", "type": "string" }, - "project_node_id": { + "node_id": { "type": "string" }, - "content_node_id": { - "type": "string" + "project_url": { + "type": "string", + "format": "uri" }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "updated_at": { "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "cards_url", + "id", + "node_id", + "name", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 ] }, - "creator": { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -835858,653 +837672,1023 @@ "url" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/octocat/Hello-World" ] }, - "archived_at": { + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-04-28T12:00:00Z" - ] - } - }, - "required": [ - "id", - "content_node_id", - "content_type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "This your first repo!" ] }, - "email": { - "type": [ - "string", - "null" + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "login": { + "archive_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "id": { - "type": "integer", + "assignees_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "node_id": { + "blobs_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "avatar_url": { + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "git:github.com/octocat/Hello-World.git" ] }, - "organizations_url": { + "issue_comment_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "repos_url": { + "issue_events_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "events_url": { + "issues_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "received_events_url": { + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "type": { + "merges_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "site_admin": { - "type": "boolean" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "starred_at": { + "notifications_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "projects_v2_item", - "organization", - "sender", - "changes" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "webhooks", - "subcategory": "projects_v2_item", - "supported-webhook-types": [ - "organization" - ] - } - } - }, - "projects-v2-item-created": { - "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", - "externalDocs": { - "url": "" - }, - "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": "project-v2-item", - "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": "Projects v2 Item Created Event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", + }, + "pulls_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "node_id": { - "description": "The global node ID of the installation.", + "releases_url": { "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { + }, + "ssh_url": { "type": "string", "examples": [ - "github" + "git@github.com:octocat/Hello-World.git" ] }, - "id": { - "type": "integer", + "stargazers_url": { + "type": "string", + "format": "uri", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "node_id": { + "statuses_url": { "type": "string", "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "repos_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/repos" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "events_url": { + "tags_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/events" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "hooks_url": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/hooks" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "issues_url": { + "trees_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/issues" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "members_url": { + "clone_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "https://github.com/octocat/Hello-World.git" ] }, - "public_members_url": { + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "avatar_url": { + "svn_url": { "type": "string", + "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://svn.github.com/octocat/Hello-World" ] }, - "description": { + "homepage": { "type": [ "string", "null" ], + "format": "uri", "examples": [ - "A great organization" + "https://github.com" ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number" }, - "node_id": { - "type": "string" + "language": { + "type": [ + "string", + "null" + ] }, - "project_node_id": { - "type": "string" + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] }, - "content_node_id": { - "type": "string" + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "examples": [ + "master" ] }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, "name": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "full_name": { + "type": "string" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "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" + } + } }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "private": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "html_url": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "description": { + "type": "string" }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "fork": { + "type": "boolean" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "archive_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "assignees_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "blobs_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "branches_url": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "collaborators_url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "comments_url": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "commits_url": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "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", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "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)." }, - "received_events_url": { + "squash_merge_commit_message": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "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." }, - "type": { + "merge_commit_title": { "type": "string", - "examples": [ - "User" - ] + "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)." }, - "site_admin": { + "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" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "created_at": { - "type": "string", - "format": "date-time", + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + false ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + false ] }, - "archived_at": { - "type": [ - "string", - "null" + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ], - "format": "date-time", + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", - "content_node_id", - "content_type", + "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", - "archived_at" + "updated_at" ] }, "sender": { @@ -836671,9 +838855,8 @@ }, "required": [ "action", - "projects_v2_item", - "organization", - "sender" + "changes", + "project_column" ] } } @@ -836686,22 +838869,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project-column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-deleted": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a classic project.", + "operationId": "project-column/moved", "externalDocs": { - "url": "" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" }, "parameters": [ { @@ -836723,7 +838907,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -836766,13 +838950,103 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Deleted Event", + "title": "project_column moved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "moved" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, "installation": { @@ -836899,34 +839173,349 @@ "description" ] }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", + "project_column": { + "title": "Project Column", "type": "object", "properties": { + "after_id": { + "type": [ + "integer", + "null" + ] + }, + "cards_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, "id": { - "type": "number" + "description": "The unique identifier of the project column", + "type": "integer" }, - "node_id": { + "name": { + "description": "Name of the project column", "type": "string" }, - "project_node_id": { + "node_id": { "type": "string" }, - "content_node_id": { - "type": "string" + "project_url": { + "type": "string", + "format": "uri" }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "updated_at": { "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "cards_url", + "id", + "node_id", + "name", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 ] }, - "creator": { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -837087,700 +839676,1023 @@ "url" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/octocat/Hello-World" ] }, - "archived_at": { + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-04-28T12:00:00Z" - ] - } - }, - "required": [ - "id", - "content_node_id", - "content_type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "This your first repo!" ] }, - "email": { - "type": [ - "string", - "null" - ] + "fork": { + "type": "boolean" }, - "login": { + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 + "https://api.github.com/repos/octocat/Hello-World" ] }, - "node_id": { + "archive_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "avatar_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "blobs_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "url": { + "branches_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "html_url": { + "collaborators_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "followers_url": { + "comments_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "following_url": { + "commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "gists_url": { + "compare_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "starred_url": { + "contents_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "subscriptions_url": { + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "type": { + "git_commits_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "git_refs_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "projects_v2_item", - "organization", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "webhooks", - "subcategory": "projects_v2_item", - "supported-webhook-types": [ - "organization" - ] - } - } - }, - "projects-v2-item-edited": { - "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", - "externalDocs": { - "url": "" - }, - "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": "project-v2-item", - "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": "Projects v2 Item Edited Event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" - ] - }, - "changes": { - "oneOf": [ - { - "type": "object", - "properties": { - "field_value": { - "type": "object", - "properties": { - "field_node_id": { - "type": "string" - }, - "field_type": { - "type": "string" - } - } - } - }, - "required": [ - "field_value" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - }, - "to": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "required": [ - "body" - ] - } - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", + "git_tags_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "node_id": { - "description": "The global node ID of the installation.", + "git_url": { "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "git:github.com/octocat/Hello-World.git" ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { + }, + "issue_comment_url": { "type": "string", "examples": [ - "github" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "id": { - "type": "integer", + "issue_events_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "node_id": { + "issues_url": { "type": "string", "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "url": { + "keys_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/orgs/github" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "repos_url": { + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/repos" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "events_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/events" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "hooks_url": { + "milestones_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/hooks" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "issues_url": { + "notifications_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/issues" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "members_url": { + "pulls_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "public_members_url": { + "releases_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "avatar_url": { + "ssh_url": { "type": "string", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "git@github.com:octocat/Hello-World.git" ] }, - "description": { + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { "type": [ "string", "null" ], + "format": "uri", "examples": [ - "A great organization" + "git:git.example.com/octocat/Hello-World" ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number" }, - "node_id": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, - "project_node_id": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, - "content_node_id": { - "type": "string" + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "examples": [ + "master" ] }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, "name": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "full_name": { + "type": "string" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "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" + } + } }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "private": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "html_url": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "description": { + "type": "string" }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "fork": { + "type": "boolean" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "archive_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "assignees_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "blobs_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "branches_url": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "collaborators_url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "comments_url": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "commits_url": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "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", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "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)." }, - "received_events_url": { + "squash_merge_commit_message": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "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." }, - "type": { + "merge_commit_title": { "type": "string", - "examples": [ - "User" - ] + "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)." }, - "site_admin": { + "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" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "created_at": { - "type": "string", - "format": "date-time", + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + false ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + false ] }, - "archived_at": { - "type": [ - "string", - "null" + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ], - "format": "date-time", + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", - "content_node_id", - "content_type", + "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", - "archived_at" + "updated_at" ] }, "sender": { @@ -837947,8 +840859,7 @@ }, "required": [ "action", - "projects_v2_item", - "organization", + "project_column", "sender" ] } @@ -837962,22 +840873,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project-column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-reordered": { + "project-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A classic project was created.", + "operationId": "project/created", "externalDocs": { - "url": "" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -837999,7 +840911,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -838042,36 +840954,104 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Reordered Event", + "title": "project created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reordered" + "created" ] }, - "changes": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "previous_projects_v2_item_node_id": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - }, - "to": { - "type": [ - "string", - "null" - ] - } - } + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -838197,34 +841177,465 @@ "description" ] }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", + "project": { + "title": "Project", "type": "object", "properties": { + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ] + }, + "columns_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { - "type": "number" + "type": "integer" }, - "node_id": { + "name": { + "description": "Name of the project", "type": "string" }, - "project_node_id": { + "node_id": { "type": "string" }, - "content_node_id": { - "type": "string" + "number": { + "type": "integer" }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "owner_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", "type": "string", "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "open", + "closed" ] }, - "creator": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -838385,1914 +841796,315 @@ "url" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/octocat/Hello-World" ] }, - "archived_at": { + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-04-28T12:00:00Z" + "This your first repo!" ] - } - }, - "required": [ - "id", - "content_node_id", - "content_type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "email": { - "type": [ - "string", - "null" + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "login": { + "assignees_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "id": { - "type": "integer", + "blobs_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "node_id": { + "branches_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "avatar_url": { + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "git:github.com/octocat/Hello-World.git" ] }, - "organizations_url": { + "issue_comment_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "repos_url": { + "issue_events_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "events_url": { + "issues_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "received_events_url": { + "keys_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "type": { + "labels_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "site_admin": { - "type": "boolean" + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] }, - "starred_at": { + "merges_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "projects_v2_item", - "organization", - "sender", - "changes" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "webhooks", - "subcategory": "projects_v2_item", - "supported-webhook-types": [ - "organization" - ] - } - } - }, - "projects-v2-item-restored": { - "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", - "externalDocs": { - "url": "" - }, - "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": "project-v2-item", - "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": "Projects v2 Item Restored Event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "restored" - ] - }, - "changes": { - "type": "object", - "properties": { - "archived_at": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "to": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - } - } - } - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", + }, + "milestones_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "node_id": { - "description": "The global node ID of the installation.", + "notifications_url": { "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { + }, + "pulls_url": { "type": "string", "examples": [ - "github" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "id": { - "type": "integer", + "releases_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "node_id": { + "ssh_url": { "type": "string", "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" + "git@github.com:octocat/Hello-World.git" ] }, - "url": { + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "repos_url": { + "statuses_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/orgs/github/repos" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "hooks_url": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/hooks" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "issues_url": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/issues" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "members_url": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "public_members_url": { + "trees_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "avatar_url": { + "clone_url": { "type": "string", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://github.com/octocat/Hello-World.git" ] }, - "description": { + "mirror_url": { "type": [ "string", "null" ], + "format": "uri", "examples": [ - "A great organization" + "git:git.example.com/octocat/Hello-World" ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number" }, - "node_id": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, - "project_node_id": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, - "content_node_id": { - "type": "string" + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", - "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] - } - }, - "required": [ - "id", - "content_node_id", - "content_type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "projects_v2_item", - "organization", - "sender", - "changes" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "webhooks", - "subcategory": "projects_v2_item", - "supported-webhook-types": [ - "organization" - ] - } - } - }, - "public": { - "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", - "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#public" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "public event", - "type": "object", - "properties": { - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" + "language": { + "type": [ + "string", + "null" ] }, "forks_count": { @@ -841166,7 +842978,8 @@ } }, "required": [ - "repository", + "action", + "project", "sender" ] } @@ -841181,7 +842994,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "public", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -841190,13 +843003,13 @@ } } }, - "pull-request-assigned": { + "project-deleted": { "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 assigned to a user.", - "operationId": "pull-request/assigned", + "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A classic project was deleted.", + "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -841261,109 +843074,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request assigned event", + "title": "project deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "assigned" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "deleted" ] }, "enterprise": { @@ -841481,10 +843198,6 @@ "node_id" ] }, - "number": { - "description": "The pull request number.", - "type": "integer" - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -841584,146 +843297,26 @@ "description" ] }, - "pull_request": { - "title": "Pull Request", + "project": { + "title": "Project", "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": { + "body": { + "description": "Body of the project", "type": [ "string", "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null ] }, - "additions": { - "type": "integer" + "columns_url": { + "type": "string", + "format": "uri" }, - "assignee": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -841806,8 +843399,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -841820,602 +843412,173 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } + "html_url": { + "type": "string", + "format": "uri" }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "id": { + "type": "integer" + }, + "name": { + "description": "Name of the project", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "owner_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", "type": "string", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "open", + "closed" ] }, - "auto_merge": { - "title": "PullRequestAutoMerge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", "properties": { - "commit_message": { - "description": "Commit message for the merge commit.", - "type": [ - "string", - "null" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 ] }, - "commit_title": { - "description": "Title for the merge commit message.", - "type": [ - "string", - "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "enabled_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" ] }, - "merge_method": { - "description": "The merge method to use.", + "full_name": { "type": "string", - "enum": [ - "merge", - "squash", - "rebase" + "examples": [ + "octocat/Hello-World" ] - } - }, - "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" + "license": { + "anyOf": [ + { + "type": "null" }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], + { + "title": "License Simple", + "description": "License Simple", + "type": "object", "properties": { "key": { - "type": "string" + "type": "string", + "examples": [ + "mit" + ] }, "name": { - "type": "string" + "type": "string", + "examples": [ + "MIT License" + ] }, - "node_id": { - "type": "string" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, "spdx_id": { - "type": "string" - }, - "url": { "type": [ "string", "null" ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", "format": "uri" } }, "required": [ "key", "name", - "spdx_id", "url", + "spdx_id", "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "master_branch": { - "type": "string" - }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -842423,908 +843586,1079 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "html_url": { + "url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "organizations_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "received_events_url": { + "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "repos_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "site_admin": { - "type": "boolean" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, "starred_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "type": { + "organizations_url": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "url": { + "repos_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "maintain": { - "type": "boolean" + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "pull": { - "type": "boolean" + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "push": { - "type": "boolean" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "triage": { + "site_admin": { "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "pull", - "push", - "admin" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "private": { - "description": "Whether the repository is private or public.", + "pull": { "type": "boolean" }, - "public": { + "triage": { "type": "boolean" }, - "pulls_url": { - "type": "string", - "format": "uri-template" + "push": { + "type": "boolean" }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ - "null", - "integer", - "string" + "string", + "null" ] }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { + "email": { "type": [ "string", "null" ] }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "login": { "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "examples": [ + "octocat" ] }, - "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" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "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 has been deprecated. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, - "visibility": { + "node_id": { "type": "string", - "enum": [ - "public", - "private", - "internal" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", - "url", - "forks_url", - "keys_url", - "collaborators_url", - "teams_url", - "hooks_url", - "issue_events_url", - "events_url", - "assignees_url", - "branches_url", - "tags_url", - "blobs_url", - "git_tags_url", - "git_refs_url", - "trees_url", - "statuses_url", - "languages_url", - "stargazers_url", - "contributors_url", - "subscribers_url", - "subscription_url", - "commits_url", - "git_commits_url", - "comments_url", - "issue_comment_url", - "contents_url", - "compare_url", - "merges_url", - "archive_url", - "downloads_url", - "issues_url", - "pulls_url", - "milestones_url", - "notifications_url", - "labels_url", - "releases_url", - "deployments_url", - "created_at", - "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { "avatar_url": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "email": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, "following_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, "gists_url": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "organizations_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "received_events_url": { + "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "starred_url": { + "events_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "examples": [ + "User" ] }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "changed_files": { - "type": "integer" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commits": { - "type": "integer" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "deletions": { - "type": "integer" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "head": { - "type": "object", - "properties": { - "label": { + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "ref": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "repo": { - "title": "Repository", - "description": "A git repository", + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { "type": [ "object", "null" ], "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false + "id": { + "type": "integer" }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" + "node_id": { + "type": "string" }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true + "name": { + "type": "string" }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true + "full_name": { + "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true + "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" + } + } }, - "allow_update_branch": { + "private": { "type": "boolean" }, - "archive_url": { - "type": "string", - "format": "uri-template" + "html_url": { + "type": "string" }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" }, "assignees_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "blobs_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" + "type": "string" }, "collaborators_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "comments_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "commits_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "compare_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "contents_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", "type": "string" }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" + "type": "string" }, "downloads_url": { - "type": "string", - "format": "uri" + "type": "string" }, "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" + "type": "string" }, "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { "type": "string" }, "git_commits_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "git_refs_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "git_tags_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "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 + "type": "string" }, - "has_pages": { - "type": "boolean" + "issue_comment_url": { + "type": "string" }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true + "issue_events_url": { + "type": "string" }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true + "issues_url": { + "type": "string" }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false + "keys_url": { + "type": "string" }, - "homepage": { - "type": [ - "string", - "null" - ] + "labels_url": { + "type": "string" }, - "hooks_url": { - "type": "string", - "format": "uri" + "languages_url": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "merges_url": { + "type": "string" }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" + "milestones_url": { + "type": "string" }, - "is_template": { - "type": "boolean" + "notifications_url": { + "type": "string" }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" + "pulls_url": { + "type": "string" }, - "issue_events_url": { - "type": "string", - "format": "uri-template" + "releases_url": { + "type": "string" }, - "issues_url": { - "type": "string", - "format": "uri-template" + "ssh_url": { + "type": "string" }, - "keys_url": { - "type": "string", - "format": "uri-template" + "stargazers_url": { + "type": "string" }, - "labels_url": { - "type": "string", - "format": "uri-template" + "statuses_url": { + "type": "string" }, - "language": { - "type": [ - "string", - "null" - ] + "subscribers_url": { + "type": "string" }, - "languages_url": { - "type": "string", - "format": "uri" + "subscription_url": { + "type": "string" }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] + "tags_url": { + "type": "string" }, - "master_branch": { + "teams_url": { "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" - ] + "trees_url": { + "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" - ] + "clone_url": { + "type": "string" }, - "merges_url": { - "type": "string", - "format": "uri" + "mirror_url": { + "type": "string" }, - "milestones_url": { - "type": "string", - "format": "uri-template" + "hooks_url": { + "type": "string" }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "svn_url": { + "type": "string" }, - "name": { - "description": "The name of the repository.", + "homepage": { "type": "string" }, - "node_id": { + "language": { "type": "string" }, - "notifications_url": { - "type": "string", - "format": "uri-template" + "forks_count": { + "type": "integer" }, - "open_issues": { + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { "type": "integer" }, + "default_branch": { + "type": "string" + }, "open_issues_count": { "type": "integer" }, - "organization": { + "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" }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" }, "permissions": { "type": "object", @@ -843335,1164 +844669,810 @@ "maintain": { "type": "boolean" }, - "pull": { - "type": "boolean" - }, "push": { "type": "boolean" }, "triage": { "type": "boolean" + }, + "pull": { + "type": "boolean" } - }, - "required": [ - "pull", - "push", - "admin" - ] + } }, - "private": { - "description": "Whether the repository is private or public.", + "allow_rebase_merge": { "type": "boolean" }, - "public": { + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { "type": "boolean" }, - "pulls_url": { - "type": "string", - "format": "uri-template" + "allow_auto_merge": { + "type": "boolean" }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] + "delete_branch_on_merge": { + "type": "boolean" }, - "releases_url": { - "type": "string", - "format": "uri-template" + "allow_update_branch": { + "type": "boolean" }, - "role_name": { - "type": [ - "string", - "null" - ] + "use_squash_pr_title_as_default": { + "type": "boolean" }, - "size": { - "type": "integer" + "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": { - "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" - ] + ], + "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." }, - "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).", + "merge_commit_title": { "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" + "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)." }, - "teams_url": { + "merge_commit_message": { "type": "string", - "format": "uri" + "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." }, - "topics": { - "type": "array", - "items": { - "type": "string" - } + "allow_merge_commit": { + "type": "boolean" }, - "trees_url": { - "type": "string", - "format": "uri-template" + "subscribers_count": { + "type": "integer" }, - "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 has been deprecated. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, - "visibility": { - "type": "string", - "enum": [ - "public", - "private", - "internal" - ] - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { + "network_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": { + "temp_clone_token": { "type": "string" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged": { - "type": [ - "boolean", - "null" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "site_admin": { - "type": "boolean" + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "starred_url": { - "type": "string", - "format": "uri-template" + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, - "subscriptions_url": { + "squash_merge_commit_title": { "type": "string", - "format": "uri" + "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)." }, - "type": { + "squash_merge_commit_message": { "type": "string", "enum": [ - "Bot", - "User", - "Organization" - ] + "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." }, - "url": { + "merge_commit_title": { "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" + "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)." }, - "created_at": { + "merge_commit_message": { "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] + "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": { - "type": [ - "string", - "null" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri" + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" }, - "id": { + "subscribers_count": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", + "network_count": { "type": "integer" }, "open_issues": { "type": "integer" }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] + "watchers": { + "type": "integer" }, - "title": { - "description": "The title of the milestone.", + "master_branch": { "type": "string" }, - "updated_at": { + "starred_at": { "type": "string", - "format": "date-time" + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] }, - "url": { - "type": "string", - "format": "uri" + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "url", + "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", - "labels_url", "id", "node_id", - "number", - "title", - "description", - "creator", + "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", - "closed_issues", - "state", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", "created_at", - "updated_at", - "due_on", - "closed_at" + "updated_at" + ] + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "patch_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "rebaseable": { + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "boolean", + "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "requested_reviewers": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - } - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "review_comment_url": { + "followers_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "review_comments": { - "type": "integer" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "review_comments_url": { + "gists_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", + "starred_url": { "type": "string", - "enum": [ - "open", - "closed" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "statuses_url": { + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "project" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a classic project was changed.", + "operationId": "project/edited", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "project edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the project if the action was `edited`.", + "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 changes to the project if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], "format": "uri" }, - "title": { - "description": "The title of the pull request.", - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", - "format": "date-time" + "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. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] }, "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "project": { + "title": "Project", + "type": "object", + "properties": { + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ] + }, + "columns_url": { "type": "string", "format": "uri" }, - "user": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -844575,8 +845555,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -844588,45 +845567,59 @@ "login", "id" ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "description": "Name of the project", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "owner_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ + "owner_url", "url", + "html_url", + "columns_url", "id", "node_id", - "html_url", - "diff_url", - "patch_url", - "issue_url", + "name", + "body", "number", "state", - "locked", - "title", - "user", - "body", + "creator", "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" + "updated_at" ] }, "repository": { @@ -846262,11 +847255,7 @@ }, "required": [ "action", - "number", - "pull_request", - "assignee", - "repository", - "sender" + "project" ] } } @@ -846280,7 +847269,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull-request", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -846289,13 +847278,13 @@ } } }, - "pull-request-auto-merge-disabled": { + "project-reopened": { "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": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A classic project was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -846360,13 +847349,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request auto_merge_disabled event", + "title": "project reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "auto_merge_disabled" + "reopened" ] }, "enterprise": { @@ -846484,9 +847473,6 @@ "node_id" ] }, - "number": { - "type": "integer" - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -846586,146 +847572,26 @@ "description" ] }, - "pull_request": { - "title": "Pull Request", + "project": { + "title": "Project", "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": { + "body": { + "description": "Body of the project", "type": [ "string", "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null ] }, - "additions": { - "type": "integer" + "columns_url": { + "type": "string", + "format": "uri" }, - "assignee": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -846821,1957 +847687,359 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } + "html_url": { + "type": "string", + "format": "uri" }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "id": { + "type": "integer" + }, + "name": { + "description": "Name of the project", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "owner_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", "type": "string", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "open", + "closed" ] }, - "auto_merge": { - "title": "PullRequestAutoMerge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], - "properties": { - "commit_message": { - "description": "Commit message for the merge commit.", - "type": [ - "string", - "null" - ] - }, - "commit_title": { - "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] - }, - "enabled_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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" + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 ] }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "repo": { - "title": "Repository", - "description": "A git repository", + { + "title": "License Simple", + "description": "License Simple", "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": { + "key": { "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" + "examples": [ + "mit" ] }, - "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": { + "name": { "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_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "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 - }, - "homepage": { - "type": [ - "string", - "null" + "examples": [ + "MIT License" ] }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "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": { + "url": { "type": [ "string", "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" ] }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "spdx_id": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "examples": [ + "MIT" ] }, - "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).", + "node_id": { "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" + "examples": [ + "MDc6TGljZW5zZW1pdA==" ] }, - "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": { + "html_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 has been deprecated. 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", + "key", "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", "url", - "forks_url", - "keys_url", - "collaborators_url", - "teams_url", - "hooks_url", - "issue_events_url", - "events_url", - "assignees_url", - "branches_url", - "tags_url", - "blobs_url", - "git_tags_url", - "git_refs_url", - "trees_url", - "statuses_url", - "languages_url", - "stargazers_url", - "contributors_url", - "subscribers_url", - "subscription_url", - "commits_url", - "git_commits_url", - "comments_url", - "issue_comment_url", - "contents_url", - "compare_url", - "merges_url", - "archive_url", - "downloads_url", - "issues_url", - "pulls_url", - "milestones_url", - "notifications_url", - "labels_url", - "releases_url", - "deployments_url", - "created_at", - "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "spdx_id", + "node_id" ] } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "body": { - "type": [ - "string", - "null" ] }, - "changed_files": { - "type": "integer" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commits": { - "type": "integer" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "deletions": { - "type": "integer" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" + "organization": { + "anyOf": [ + { + "type": "null" }, - "repo": { - "title": "Repository", - "description": "A git repository", + { + "title": "Simple User", + "description": "A GitHub user.", "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": { + "name": { "type": [ "string", "null" ] }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { + "email": { "type": [ "string", "null" ] }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "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": { + "login": { "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" + "examples": [ + "octocat" ] }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "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.", + "node_id": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "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).", + "avatar_url": { "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "gravatar_id": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "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" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { + "url": { "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "releases_url": { + "html_url": { "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "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.", + "followers_url": { "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "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).", + "following_url": { "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "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": { + "gists_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "updated_at": { + "starred_url": { "type": "string", - "format": "date-time" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "url": { + "subscriptions_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 has been deprecated. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "visibility": { + "organizations_url": { "type": "string", - "enum": [ - "public", - "private", - "internal" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", - "url", - "forks_url", - "keys_url", - "collaborators_url", - "teams_url", - "hooks_url", - "issue_events_url", - "events_url", - "assignees_url", - "branches_url", - "tags_url", - "blobs_url", - "git_tags_url", - "git_refs_url", - "trees_url", - "statuses_url", - "languages_url", - "stargazers_url", - "contributors_url", - "subscribers_url", - "subscription_url", - "commits_url", - "git_commits_url", - "comments_url", - "issue_comment_url", - "contents_url", - "compare_url", - "merges_url", - "archive_url", - "downloads_url", - "issues_url", - "pulls_url", - "milestones_url", - "notifications_url", - "labels_url", - "releases_url", - "deployments_url", - "created_at", - "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { + "repos_url": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, "site_admin": { "type": "boolean" }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { + "starred_at": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" ] }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { + "forks": { "type": "integer" }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged": { - "type": [ - "boolean", - "null" + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" ] }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { - "title": "User", - "type": [ - "object", - "null" - ], + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -848779,1317 +848047,165 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "id": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "login": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "name": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "organizations_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "received_events_url": { + "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "starred_url": { + "events_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "examples": [ + "User" ] }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "requested_reviewers": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - } - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id" - ] - } - }, - "review_comment_url": { - "type": "string", - "format": "uri-template" - }, - "review_comments": { - "type": "integer" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "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" - ] - }, - "reason": { - "type": "string" - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", + "string", "null" ], "examples": [ @@ -851258,10 +849374,7 @@ }, "required": [ "action", - "number", - "pull_request", - "reason", - "repository", + "project", "sender" ] } @@ -851276,7 +849389,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull-request", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -851285,13 +849398,13 @@ } } }, - "pull-request-auto-merge-enabled": { + "projects-v2-item-archived": { "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": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" + "url": "" }, "parameters": [ { @@ -851313,7 +849426,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -851356,105 +849469,673 @@ "content": { "application/json": { "schema": { - "title": "pull_request auto_merge_enabled event", + "title": "Projects v2 Item Archived Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "auto_merge_enabled" + "archived" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "changes": { "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "archived_at": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "to": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 ] }, - "html_url": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", - "format": "uri", "examples": [ - "https://github.com/enterprises/octo-business" + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" }, "id": { - "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 42 + 1 ] }, "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "name": { - "description": "The name of the enterprise.", + "url": { "type": "string", + "format": "uri", "examples": [ - "Octo Business" + "https://api.github.com/orgs/github" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "octo-business" + "https://api.github.com/orgs/github/repos" ] }, - "created_at": { + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { "type": [ "string", "null" ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", "format": "date-time", "examples": [ - "2019-01-26T19:01:12Z" + "2022-04-28T12:00:00Z" ] }, "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-converted": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Converted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "converted" ] }, + "changes": { + "type": "object", + "properties": { + "content_type": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": "string" + } + } + } + } + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -851480,9 +850161,6 @@ "node_id" ] }, - "number": { - "type": "integer" - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -851582,146 +850260,18819 @@ "description" ] }, - "pull_request": { - "title": "Pull Request", + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", "type": "object", "properties": { - "_links": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "comments": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "name": { + "type": [ + "string", + "null" ] }, - "commits": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "email": { + "type": [ + "string", + "null" ] }, - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "login": { + "type": "string", + "examples": [ + "octocat" ] }, - "issue": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "review_comment": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "review_comments": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "statuses": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] - } - }, - "required": [ - "self", - "html", - "issue", - "comments", - "review_comments", - "review_comment", - "commits", - "statuses" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-created": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Created Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Deleted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-edited": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Edited Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "oneOf": [ + { + "type": "object", + "properties": { + "field_value": { + "type": "object", + "properties": { + "field_node_id": { + "type": "string" + }, + "field_type": { + "type": "string" + } + } + } + }, + "required": [ + "field_value" + ] + }, + { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "required": [ + "body" + ] + } + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-reordered": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Reordered Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reordered" + ] + }, + "changes": { + "type": "object", + "properties": { + "previous_projects_v2_item_node_id": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": [ + "string", + "null" + ] + } + } + } + } + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-restored": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Restored Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "restored" + ] + }, + "changes": { + "type": "object", + "properties": { + "archived_at": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "to": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "public": { + "post": { + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#public" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "public event", + "type": "object", + "properties": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "public", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-assigned": { + "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 assigned to a user.", + "operationId": "pull-request/assigned", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/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": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "pull_request assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "number", + "pull_request", + "assignee", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull-request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-auto-merge-disabled": { + "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": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/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": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "pull_request auto_merge_disabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_merge_disabled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "number": { + "type": "integer" + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "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 + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "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" + ] + }, + "reason": { + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "number", + "pull_request", + "reason", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull-request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-auto-merge-enabled": { + "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": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/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": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "pull_request auto_merge_enabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_merge_enabled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "number": { + "type": "integer" + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" ] }, - "active_lock_reason": { + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { "type": [ "string", "null" ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "open", + "closed" ] }, - "additions": { - "type": "integer" + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" }, - "assignee": { + "url": { + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -851804,7 +869155,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -851816,144 +869168,2149 @@ "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" + ] + }, + "reason": { + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "name": { - "type": "string" + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "node_id": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] + "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" + } } }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "number", + "pull_request", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull-request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-closed": { + "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 closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", + "externalDocs": { + "url": "https://docs.github.com/developers/webhooks-and-events/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": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "pull_request closed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "examples": [ + "https://api.github.com/orgs/github/issues" ] }, - "auto_merge": { - "title": "PullRequestAutoMerge", - "description": "The status of auto merging a pull request.", + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { "type": [ - "object", + "string", "null" ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "pull_request": { + "allOf": [ + { + "title": "Pull Request", + "type": "object", "properties": { - "commit_message": { - "description": "Commit message for the merge commit.", - "type": [ - "string", - "null" + "_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" ] }, - "commit_title": { - "description": "Title for the merge commit message.", + "active_lock_reason": { "type": [ "string", "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "enabled_by": { + "additions": { + "type": "integer" + }, + "assignee": { "title": "User", "type": [ "object", @@ -852036,7 +871393,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -852049,357 +871407,1743 @@ "id" ] }, - "merge_method": { - "description": "The merge method to use.", + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", "enum": [ - "merge", - "squash", - "rebase" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] - } - }, - "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", + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] }, - "contributors_url": { - "type": "string", - "format": "uri" + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] }, - "created_at": { - "oneOf": [ - { + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - { + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "format": "date-time" + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, - "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": { + "merge_method": { + "description": "The merge method to use.", "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" + "enum": [ + "merge", + "squash", + "rebase" ] - }, - "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": { + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { "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 + "ref": { + "type": "string" }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. 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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false + "sha": { + "type": "string" }, - "homepage": { + "user": { + "title": "User", "type": [ - "string", + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "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": { + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { "type": [ "string", "null" ] }, - "languages_url": { - "type": "string", - "format": "uri" + "ref": { + "type": "string" }, - "license": { - "title": "License", + "repo": { + "title": "Repository", + "description": "A git repository", "type": [ "object", "null" ], "properties": { - "key": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { "type": "string" }, + "merge_commit_message": { + "description": "The default value for a merge commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit message title.", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, "name": { + "description": "The name of the repository.", "type": "string" }, "node_id": { "type": "string" }, - "spdx_id": { + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { "type": "string" }, - "url": { + "owner": { + "title": "User", "type": [ - "string", + "object", "null" ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title.", + "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 has been deprecated. 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": [ - "key", + "id", + "node_id", "name", - "spdx_id", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", "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" + "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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" ] }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { + "sha": { "type": "string" }, - "owner": { + "user": { "title": "User", "type": [ "object", @@ -852494,250 +873238,109 @@ "login", "id" ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } + } + }, + "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" }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" } }, - "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 has been deprecated. 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" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" ] }, - "sha": { + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { "type": "string" }, - "user": { + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { "title": "User", "type": [ "object", @@ -852832,395 +873435,30 @@ "login", "id" ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "changed_files": { - "type": "integer" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commits": { - "type": "integer" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "deletions": { - "type": "integer" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" }, - "repo": { - "title": "Repository", - "description": "A git repository", - "type": "object", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "closed_at": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" + "format": "date-time" }, - "open_issues_count": { + "closed_issues": { "type": "integer" }, - "organization": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "owner": { + "creator": { "title": "User", "type": [ "object", @@ -853303,7 +873541,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -853316,134 +873555,51 @@ "id" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], + "description": { "type": [ - "null", - "integer", - "string" + "string", + "null" ] }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { + "due_on": { "type": [ "string", "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" + ], + "format": "date-time" }, - "stargazers_url": { + "html_url": { "type": "string", "format": "uri" }, - "statuses_url": { - "type": "string", - "format": "uri-template" + "id": { + "type": "integer" }, - "subscribers_url": { + "labels_url": { "type": "string", "format": "uri" }, - "subscription_url": { - "type": "string", - "format": "uri" + "node_id": { + "type": "string" }, - "svn_url": { - "type": "string", - "format": "uri" + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "tags_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, - "teams_url": { + "state": { + "description": "The state of the milestone.", "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } + "enum": [ + "open", + "closed" + ] }, - "trees_url": { - "type": "string", - "format": "uri-template" + "title": { + "description": "The title of the milestone.", + "type": "string" }, "updated_at": { "type": "string", @@ -853452,717 +873608,295 @@ "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 has been deprecated. 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": [ + "url", + "html_url", + "labels_url", "id", "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", + "number", + "title", "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", + "creator", + "open_issues", + "closed_issues", + "state", "created_at", "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged": { - "type": [ - "boolean", - "null" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "due_on", + "closed_at" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { + "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, - "created_at": { + "patch_url": { "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] + "format": "uri" }, - "due_on": { + "rebaseable": { "type": [ - "string", + "boolean", "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "requested_reviewers": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", "type": [ - "string", + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "login", - "id" ] - }, - { + } + }, + "requested_teams": { + "type": "array", + "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", @@ -854294,334 +874028,1409 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - } - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" + "id" ] - }, - "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" + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "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" ] }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], + { + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "_links": { + "type": "object", + "properties": { + "comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "commits": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "issue": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comment": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "statuses": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } }, - "deleted": { - "type": "boolean" + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "email": { + "additions": { + "type": "integer" + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "auto_merge": { + "type": [ + "object", + "null" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "allow_auto_merge": { + "type": "boolean" + }, + "allow_forking": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "clone_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" + }, + "created_at": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "type": "boolean" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "has_downloads": { + "type": "boolean" + }, + "has_issues": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string" + }, + "license": { + "type": [ + "object", + "null" + ] + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "topics": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "trees_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "type": "boolean" + } + } + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + } + } + } + } + }, + "body": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "changed_files": { + "type": "integer" }, - "followers_url": { - "type": "string", - "format": "uri" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "following_url": { - "type": "string", - "format": "uri-template" + "comments": { + "type": "integer" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "comments_url": { + "type": "string" }, - "gravatar_id": { + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { "type": "string" }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "type": "boolean" + }, + "allow_forking": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "clone_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" + }, + "created_at": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "type": "boolean" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "has_downloads": { + "type": "boolean" + }, + "has_issues": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string" + }, + "license": { + "type": [ + "object", + "null" + ] + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "owner": { + "type": [ + "object", + "null" + ], + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "topics": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "trees_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "type": "boolean" + } + } + }, + "sha": { + "type": "string" + }, + "user": { + "type": [ + "object", + "null" + ], + "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" + } + } + } + } + }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, - "login": { + "issue_url": { "type": "string" }, - "name": { + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { "type": "string" }, + "merged": { + "type": "boolean" + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "merged_by": { + "type": [ + "object", + "null" + ] + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri" + "patch_url": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "rebaseable": { + "type": [ + "boolean", + "null" + ] }, - "site_admin": { - "type": "boolean" + "requested_reviewers": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + "requested_teams": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "review_comment_url": { + "type": "string" }, - "type": { + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "closed", + "open" ] }, + "statuses_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" + "state", + "closed_at", + "merged" ] } - }, - "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" ] }, - "reason": { - "type": "string" - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -856281,11 +877090,11 @@ } } }, - "pull-request-closed": { + "pull-request-converted-to-draft": { "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 closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" }, @@ -856352,13 +877161,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request closed event", + "title": "pull_request converted_to_draft event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed" + "converted_to_draft" ] }, "enterprise": { @@ -856803,8 +877612,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -856902,8 +877710,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -857557,7 +878364,7 @@ "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.", + "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", @@ -857886,10 +878693,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -858165,7 +878969,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", @@ -858174,7 +878978,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", @@ -858378,7 +879182,7 @@ "type": "integer" }, "squash_merge_commit_message": { - "description": "The default value for a 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", @@ -858387,7 +879191,7 @@ ] }, "squash_merge_commit_title": { - "description": "The default value for a 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", @@ -858648,322 +879452,321 @@ "login", "id" ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged": { - "type": [ - "boolean", - "null" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, "description": { "type": [ @@ -859143,8 +879946,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -859289,16 +880091,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -859925,7 +880718,6 @@ }, "mirror_url": { "type": [ - "string", "null" ] }, @@ -860172,8 +880964,7 @@ "type": [ "string", "null" - ], - "format": "date-time" + ] }, "comments": { "type": "integer" @@ -860197,16 +880988,14 @@ "type": "string" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -860411,7 +881200,6 @@ }, "mirror_url": { "type": [ - "string", "null" ] }, @@ -860431,10 +881219,7 @@ "type": "integer" }, "owner": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "avatar_url": { "type": "string" @@ -860588,10 +881373,7 @@ "type": "string" }, "user": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "avatar_url": { "type": "string" @@ -860691,17 +881473,18 @@ "type": "string" }, "merged": { - "type": "boolean" + "type": "boolean", + "enum": [ + false + ] }, "merged_at": { "type": [ - "string", "null" ] }, "merged_by": { "type": [ - "object", "null" ] }, @@ -860754,12 +881537,7 @@ "type": "string" }, "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "type": "string", - "enum": [ - "closed", - "open" - ] + "type": "string" }, "statuses_url": { "type": "string" @@ -860834,9 +881612,11 @@ } }, "required": [ - "state", "closed_at", - "merged" + "merged_at", + "draft", + "merged", + "merged_by" ] } ] @@ -862500,11 +883280,11 @@ } } }, - "pull-request-converted-to-draft": { + "pull-request-demilestoned": { "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 converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" }, @@ -862571,13 +883351,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request converted_to_draft event", + "title": "pull_request demilestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "converted_to_draft" + "demilestoned" ] }, "enterprise": { @@ -862599,100 +883379,382 @@ "https://github.com/enterprises/octo-business" ] }, - "website_url": { - "description": "The enterprise's website URL.", + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "Tracking milestone for version 1.0" + ] }, - "id": { - "description": "Unique identifier of the enterprise", + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { "type": "integer", "examples": [ - 42 + 4 ] }, - "node_id": { - "type": "string", + "closed_issues": { + "type": "integer", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + 8 ] }, - "name": { - "description": "The name of the enterprise.", + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "Octo Business" + "2011-04-10T20:09:31Z" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "octo-business" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2019-01-26T19:01:12Z" + "2013-02-12T13:22:01Z" ] }, - "updated_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "2012-10-09T23:39:01Z" ] - }, - "avatar_url": { - "type": "string", - "format": "uri" } }, "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", "id", "node_id", - "name", - "slug", + "labels_url", "html_url", + "number", + "open_issues", + "state", + "title", + "url", "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" + "updated_at" ] }, "number": { @@ -862799,147 +883861,379 @@ ] }, "pull_request": { - "allOf": [ - { - "title": "Pull Request", + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { "type": "object", "properties": { - "_links": { + "comments": { + "title": "Link", "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" - ] + "href": { + "type": "string", + "format": "uri-template" } }, "required": [ - "self", - "html", - "issue", - "comments", - "review_comments", - "review_comment", - "commits", - "statuses" + "href" ] }, - "active_lock_reason": { + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null ] }, - "additions": { + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "assignee": { + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { "title": "User", "type": [ "object", @@ -863035,1739 +884329,357 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "merge_method": { + "description": "The merge method to use.", "type": "string", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "merge", + "squash", + "rebase" ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "auto_merge": { - "title": "PullRequestAutoMerge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", "properties": { - "commit_message": { - "description": "Commit message for the merge commit.", - "type": [ - "string", - "null" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "commit_title": { - "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" }, - "enabled_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "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" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "ref": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "repo": { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n - `PR_BODY` - default to the pull request's body.\n - `COMMIT_MESSAGES` - default to the branch's commit messages.\n - `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. 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", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] + "allow_update_branch": { + "type": "boolean" }, - "sha": { - "type": "string" + "archive_url": { + "type": "string", + "format": "uri-template" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "changed_files": { - "type": "integer" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commits": { - "type": "integer" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "deletions": { - "type": "integer" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false }, - "ref": { - "type": "string" + "assignees_url": { + "type": "string", + "format": "uri-template" }, - "repo": { - "title": "Repository", - "description": "A git repository", - "type": [ - "object", - "null" - ], - "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", + "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" }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { + { "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, "name": { - "description": "The name of the repository.", "type": "string" }, "node_id": { "type": "string" }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { + "spdx_id": { "type": "string" }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { + "url": { "type": [ "string", "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n - `PR_BODY` - default to the pull request's body.\n - `COMMIT_MESSAGES` - default to the branch's commit messages.\n - `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", + ], "format": "uri" - }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. 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", + "key", "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", + "spdx_id", "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", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" + "node_id" ] }, - "sha": { + "master_branch": { "type": "string" }, - "user": { + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -864862,109 +884774,250 @@ "login", "id" ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } }, - "node_id": { + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" } }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" + "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.", + "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" ] }, - "mergeable_state": { + "sha": { "type": "string" }, - "merged": { - "type": [ - "boolean", - "null" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { + "user": { "title": "User", "type": [ "object", @@ -865059,30 +885112,395 @@ "login", "id" ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", "properties": { - "closed_at": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { + "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" }, - "created_at": { + "forks_count": { + "type": "integer" + }, + "forks_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "creator": { + "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 + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -865178,18 +885596,286 @@ "id" ] }, - "description": { + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { "type": [ "string", "null" ] }, - "due_on": { + "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.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "format": "date-time" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -865198,35 +885884,362 @@ "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string", "enum": [ - "open", - "closed" + "Bot", + "User", + "Organization" ] }, - "title": { - "description": "The title of the milestone.", + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, "url": { "type": "string", @@ -865234,282 +886247,202 @@ } }, "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" + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" ] }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, "node_id": { "type": "string" }, "number": { - "description": "Number uniquely identifying the pull request within its repository.", + "description": "The number of the milestone.", "type": "integer" }, - "patch_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, - "rebaseable": { - "type": [ - "boolean", - "null" + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] }, - "requested_reviewers": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "User", + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ - "object", + "string", "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" ] }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id" + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] - } - }, - "requested_teams": { - "type": "array", - "items": { + }, + { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", @@ -865644,1391 +886577,317 @@ "id" ] } - }, - "review_comment_url": { - "type": "string", - "format": "uri-template" - }, - "review_comments": { - "type": "integer" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "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" - ] + ] + } }, - { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "comments": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "commits": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "issue": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "review_comment": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "review_comments": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "self": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "statuses": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - } - } - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "additions": { - "type": "integer" - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "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": [ - "object", + "string", "null" ] - } - }, - "author_association": { - "type": "string" - }, - "auto_merge": { - "type": [ - "object", - "null" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "allow_auto_merge": { - "type": "boolean" - }, - "allow_forking": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "clone_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" - }, - "created_at": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "deployments_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "type": "boolean" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string" - }, - "license": { - "type": [ - "object", - "null" - ] - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "null" - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "topics": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "trees_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "type": "boolean" - } + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" } }, - "sha": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } + "required": [ + "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" } }, - "body": { - "type": [ - "string", - "null" - ] + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "changed_files": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "closed_at": { + "email": { "type": [ "string", "null" ] }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "commits": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "commits_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "created_at": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "deletions": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "diff_url": { + "gravatar_id": { "type": "string" }, - "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": { - "type": [ - "object", - "null" - ], - "properties": { - "allow_auto_merge": { - "type": "boolean" - }, - "allow_forking": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "clone_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" - }, - "created_at": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "deployments_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "type": "boolean" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string" - }, - "license": { - "type": [ - "object", - "null" - ] - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "null" - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "topics": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "trees_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - } - }, - "sha": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } - } - } - }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "issue_url": { + "login": { "type": "string" }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { + "name": { "type": "string" }, - "merged": { - "type": "boolean", - "enum": [ - false - ] - }, - "merged_at": { - "type": [ - "null" - ] - }, - "merged_by": { - "type": [ - "null" - ] - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, "node_id": { "type": "string" }, - "number": { - "type": "integer" - }, - "patch_url": { - "type": "string" - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "requested_reviewers": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "review_comment_url": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri" }, - "review_comments": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "review_comments_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "state": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "statuses_url": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "title": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "updated_at": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "type": "string", + "format": "uri" } }, "required": [ - "closed_at", - "merged_at", - "draft", - "merged", - "merged_by" + "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": { @@ -868666,8 +888525,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -868690,11 +888548,11 @@ } } }, - "pull-request-demilestoned": { + "pull-request-dequeued": { "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 removed from a milestone.", - "operationId": "pull-request/demilestoned", + "description": "A pull request was removed from the merge queue.\n\n**Note**: The pull request merge queue feature is currently in limited public beta and subject to change.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" }, @@ -868761,13 +888619,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request demilestoned event", + "title": "pull_request dequeued event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "demilestoned" + "dequeued" ] }, "enterprise": { @@ -868860,315 +888718,32 @@ "avatar_url" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, "id": { + "description": "The ID of the installation.", "type": "integer", "examples": [ - 1002604 + 1 ] }, "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" + "node_id" ] }, "number": { - "description": "The pull request number.", "type": "integer" }, "organization": { @@ -869492,8 +889067,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -869591,8 +889165,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -870323,7 +889896,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -871144,7 +890717,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -871528,8 +891101,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -872300,6 +891872,9 @@ "draft" ] }, + "reason": { + "type": "string" + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -873935,7 +893510,9 @@ "action", "number", "pull_request", - "repository" + "repository", + "sender", + "reason" ] } } @@ -1048568,10 +1068145,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1050958,10 +1070542,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1053517,10 +1073108,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1058299,10 +1077897,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", diff --git a/lib/rest/static/dereferenced/ghec.deref.json b/lib/rest/static/dereferenced/ghec.deref.json index 1a8d820a84c8..a2b1780ea723 100644 --- a/lib/rest/static/dereferenced/ghec.deref.json +++ b/lib/rest/static/dereferenced/ghec.deref.json @@ -1561,6 +1561,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -2289,6 +2297,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -20779,6 +20792,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -20801,6 +20820,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -72125,6 +72147,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -72147,6 +72175,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -89902,6 +89933,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -90666,6 +90705,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -100589,6 +100633,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -180662,7 +180711,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-branches" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches" }, "parameters": [ { @@ -182783,8 +182832,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -182798,7 +182846,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -185697,8 +185745,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -185712,7 +185759,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -187948,8 +187995,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -187961,7 +188008,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -190400,8 +190447,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -190413,7 +190460,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -190479,8 +190526,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -190494,7 +190541,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -190570,8 +190617,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -190583,7 +190630,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -190659,8 +190706,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -190672,7 +190719,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -190738,8 +190785,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -190753,7 +190800,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -192359,8 +192406,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -192372,7 +192419,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -194168,8 +194215,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -194181,7 +194228,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -194247,8 +194294,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -194262,7 +194309,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -194364,8 +194411,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -194377,7 +194424,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -194479,8 +194526,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -194492,7 +194539,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -194558,8 +194605,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -194573,7 +194620,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -194722,8 +194769,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -194735,7 +194782,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -195013,8 +195060,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -195026,7 +195073,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -195066,8 +195113,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -195081,7 +195128,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -195164,8 +195211,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -195177,7 +195224,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -195412,8 +195459,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -195425,7 +195472,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -195632,8 +195679,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -195645,7 +195692,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -195851,8 +195898,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -195866,7 +195913,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -196330,8 +196377,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -196343,7 +196390,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -196383,8 +196430,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -196398,7 +196445,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -196843,8 +196890,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -196856,7 +196903,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -197397,8 +197444,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -197410,7 +197457,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -197951,8 +197998,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -197964,7 +198011,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -198504,8 +198551,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -198519,7 +198566,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -198812,8 +198859,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -198825,7 +198872,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -199216,8 +199263,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -199229,7 +199276,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -199620,8 +199667,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -199633,7 +199680,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -200023,8 +200070,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -200038,7 +200085,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -200298,8 +200345,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -200311,7 +200358,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -200668,8 +200715,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -200681,7 +200728,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -201038,8 +201085,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -201051,7 +201098,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -201407,8 +201454,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -201422,7 +201469,7 @@ "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#rename-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -204417,8 +204464,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -281916,6 +281962,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -355078,6 +355129,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -355383,7 +355439,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -355479,8 +355535,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -355494,7 +355549,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -356454,8 +356509,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -416246,10 +416300,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -416850,10 +416911,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -417448,10 +417516,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -418828,6 +418903,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -418951,6 +419031,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -419267,6 +419352,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -427100,10 +427190,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -427112,7 +427198,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -427121,6 +427206,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -427232,6 +427320,7 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", "properties": { "value": { "type": "string" @@ -427241,14 +427330,31 @@ } } } + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } } }, "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -427845,10 +427951,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -427857,7 +427959,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -427866,6 +427967,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -427977,10 +428081,31 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "roles": { + "type": "array", + "items": { + "type": "object", "properties": { "value": { "type": "string" }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, "display": { "type": "string" } @@ -427991,9 +428116,6 @@ "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -428722,10 +428844,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -428734,7 +428852,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -428743,6 +428860,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -428854,6 +428974,7 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", "properties": { "value": { "type": "string" @@ -428863,14 +428984,31 @@ } } } + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } } }, "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -429213,10 +429351,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -429225,7 +429359,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -429234,6 +429367,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -429345,10 +429481,31 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "roles": { + "type": "array", + "items": { + "type": "object", "properties": { "value": { "type": "string" }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, "display": { "type": "string" } @@ -429359,9 +429516,6 @@ "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -429821,10 +429975,6 @@ ] } }, - "required": [ - "givenName", - "familyName" - ], "example": { "givenName": "Jane", "familyName": "User" @@ -429833,7 +429983,6 @@ "emails": { "description": "user emails", "type": "array", - "minItems": 1, "items": { "type": "object", "properties": { @@ -429842,6 +429991,9 @@ }, "primary": { "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ @@ -429953,10 +430105,31 @@ "description": "associated groups", "type": "array", "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "roles": { + "type": "array", + "items": { + "type": "object", "properties": { "value": { "type": "string" }, + "primary": { + "type": "boolean" + }, + "type": { + "type": "string" + }, "display": { "type": "string" } @@ -429967,9 +430140,6 @@ "required": [ "id", "schemas", - "externalId", - "userName", - "name", "emails", "active", "meta" @@ -466652,728 +466822,733 @@ "application/json": { "schema": { "type": "object" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": null - } - } - }, - "/user/codespaces/{codespace_name}/exports": { - "post": { - "summary": "Export a codespace for the authenticated user", - "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/export-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Fetches information about an export of a codespace.", - "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", - "properties": { - "state": { - "type": [ - "string", - "null" - ], - "description": "State of the latest export", - "examples": [ - "succeeded | failed | in_progress" - ] - }, - "completed_at": { - "description": "Completion time of the last export operation", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-01-01T19:01:12Z" - ] - }, - "branch": { - "type": [ - "string", - "null" - ], - "description": "Name of the exported branch", - "examples": [ - "codespace-monalisa-octocat-hello-world-g4wpq6h95q" - ] - }, - "sha": { - "type": [ - "string", - "null" - ], - "description": "Git commit SHA of the exported branch", - "examples": [ - "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" - ] - }, - "id": { - "type": "string", - "description": "Id for the export details", - "examples": [ - "latest" - ] - }, - "export_url": { - "type": "string", - "description": "Url for fetching export details", - "examples": [ - "https://api.github.com/user/codespaces/:name/exports/latest" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "description": "Web url for the exported branch", - "examples": [ - "https://github.com/octocat/hello-world/tree/:branch" - ] - } - } }, "examples": { "default": { - "value": { - "state": "succeeded", - "completed_at": "2022-01-01T14:59:22Z", - "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", - "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", - "id": "latest", - "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": null - } - } - }, - "/user/codespaces/{codespace_name}/exports/{export_id}": { - "get": { - "summary": "Get details about a codespace export", - "description": "Gets information about an export of a codespace.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/get-export-details-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export" - }, - "parameters": [ - { - "name": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", - "schema": { - "type": "string" - } - }, - { - "name": "export_id", - "in": "path", - "required": true, - "description": "The ID of the export operation, or `latest`. Currently only `latest` is currently supported.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Fetches information about an export of a codespace.", - "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", - "properties": { - "state": { - "type": [ - "string", - "null" - ], - "description": "State of the latest export", - "examples": [ - "succeeded | failed | in_progress" - ] - }, - "completed_at": { - "description": "Completion time of the last export operation", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-01-01T19:01:12Z" - ] - }, - "branch": { - "type": [ - "string", - "null" - ], - "description": "Name of the exported branch", - "examples": [ - "codespace-monalisa-octocat-hello-world-g4wpq6h95q" - ] - }, - "sha": { - "type": [ - "string", - "null" - ], - "description": "Git commit SHA of the exported branch", - "examples": [ - "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" - ] - }, - "id": { - "type": "string", - "description": "Id for the export details", - "examples": [ - "latest" - ] - }, - "export_url": { - "type": "string", - "description": "Url for fetching export details", - "examples": [ - "https://api.github.com/user/codespaces/:name/exports/latest" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "description": "Web url for the exported branch", - "examples": [ - "https://github.com/octocat/hello-world/tree/:branch" - ] - } - } - }, - "examples": { - "default": { - "value": { - "state": "succeeded", - "completed_at": "2022-01-01T14:59:22Z", - "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", - "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", - "id": "latest", - "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": null - } - } - }, - "/user/codespaces/{codespace_name}/machines": { - "get": { - "summary": "List machine types for a codespace", - "description": "List the machine types a codespace can transition to use.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/codespace-machines-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/codespaces#list-machine-types-for-a-codespace" - }, - "parameters": [ - { - "name": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "machines" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "machines": { - "type": "array", - "items": { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "examples": [ - "standardLinux" - ] - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "examples": [ - "4 cores, 8 GB RAM, 64 GB storage" - ] - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "examples": [ - "linux" - ] - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "examples": [ - 68719476736 - ] - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "examples": [ - 8589934592 - ] - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "examples": [ - 4 - ] - }, - "prebuild_availability": { - "type": [ - "string", - "null" - ], - "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", - "enum": [ - "none", - "ready", - "in_progress", - null - ], - "examples": [ - "ready" - ] - } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "machines": [ - { - "name": "standardLinux", - "display_name": "4 cores, 8 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 8589934592, - "cpus": 4 - }, - { - "name": "premiumLinux", - "display_name": "8 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 8 - } - ] - } + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": null + } + } + }, + "/user/codespaces/{codespace_name}/exports": { + "post": { + "summary": "Export a codespace for the authenticated user", + "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/export-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Fetches information about an export of a codespace.", + "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", + "properties": { + "state": { + "type": [ + "string", + "null" + ], + "description": "State of the latest export", + "examples": [ + "succeeded | failed | in_progress" + ] + }, + "completed_at": { + "description": "Completion time of the last export operation", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-01-01T19:01:12Z" + ] + }, + "branch": { + "type": [ + "string", + "null" + ], + "description": "Name of the exported branch", + "examples": [ + "codespace-monalisa-octocat-hello-world-g4wpq6h95q" + ] + }, + "sha": { + "type": [ + "string", + "null" + ], + "description": "Git commit SHA of the exported branch", + "examples": [ + "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" + ] + }, + "id": { + "type": "string", + "description": "Id for the export details", + "examples": [ + "latest" + ] + }, + "export_url": { + "type": "string", + "description": "Url for fetching export details", + "examples": [ + "https://api.github.com/user/codespaces/:name/exports/latest" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "description": "Web url for the exported branch", + "examples": [ + "https://github.com/octocat/hello-world/tree/:branch" + ] + } + } + }, + "examples": { + "default": { + "value": { + "state": "succeeded", + "completed_at": "2022-01-01T14:59:22Z", + "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", + "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", + "id": "latest", + "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": null + } + } + }, + "/user/codespaces/{codespace_name}/exports/{export_id}": { + "get": { + "summary": "Get details about a codespace export", + "description": "Gets information about an export of a codespace.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-export-details-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export" + }, + "parameters": [ + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + }, + { + "name": "export_id", + "in": "path", + "required": true, + "description": "The ID of the export operation, or `latest`. Currently only `latest` is currently supported.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Fetches information about an export of a codespace.", + "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", + "properties": { + "state": { + "type": [ + "string", + "null" + ], + "description": "State of the latest export", + "examples": [ + "succeeded | failed | in_progress" + ] + }, + "completed_at": { + "description": "Completion time of the last export operation", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-01-01T19:01:12Z" + ] + }, + "branch": { + "type": [ + "string", + "null" + ], + "description": "Name of the exported branch", + "examples": [ + "codespace-monalisa-octocat-hello-world-g4wpq6h95q" + ] + }, + "sha": { + "type": [ + "string", + "null" + ], + "description": "Git commit SHA of the exported branch", + "examples": [ + "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" + ] + }, + "id": { + "type": "string", + "description": "Id for the export details", + "examples": [ + "latest" + ] + }, + "export_url": { + "type": "string", + "description": "Url for fetching export details", + "examples": [ + "https://api.github.com/user/codespaces/:name/exports/latest" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "description": "Web url for the exported branch", + "examples": [ + "https://github.com/octocat/hello-world/tree/:branch" + ] + } + } + }, + "examples": { + "default": { + "value": { + "state": "succeeded", + "completed_at": "2022-01-01T14:59:22Z", + "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", + "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", + "id": "latest", + "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": null + } + } + }, + "/user/codespaces/{codespace_name}/machines": { + "get": { + "summary": "List machine types for a codespace", + "description": "List the machine types a codespace can transition to use.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/codespace-machines-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/reference/codespaces#list-machine-types-for-a-codespace" + }, + "parameters": [ + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "machines" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "machines": { + "type": "array", + "items": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "examples": [ + "standardLinux" + ] + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "examples": [ + "4 cores, 8 GB RAM, 64 GB storage" + ] + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "examples": [ + "linux" + ] + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "examples": [ + 68719476736 + ] + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "examples": [ + 8589934592 + ] + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "examples": [ + 4 + ] + }, + "prebuild_availability": { + "type": [ + "string", + "null" + ], + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "enum": [ + "none", + "ready", + "in_progress", + null + ], + "examples": [ + "ready" + ] + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "machines": [ + { + "name": "standardLinux", + "display_name": "4 cores, 8 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 8589934592, + "cpus": 4 + }, + { + "name": "premiumLinux", + "display_name": "8 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 8 + } + ] + } } } } @@ -557206,13 +557381,13 @@ } } }, - "check-suite-completed": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -557277,1268 +557452,2698 @@ "content": { "application/json": { "schema": { - "title": "check_suite completed event", + "title": "Check Run Requested Action Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "completed" - ] - }, - "actions_meta": { - "type": [ - "object", - "null" + "requested_action" ] }, - "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#suites).", + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { - "after": { - "type": [ - "string", - "null" - ] - }, "app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "merge_group", - "pull_request_review_thread", - "workflow_job", - "merge_queue_entry", - "security_and_analysis", - "projects_v2_item", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "anyOf": [ + { + "type": "null" }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 ] }, - "checks": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "probot-owners" ] }, - "content_references": { + "node_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" ] }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "deployments": { + "name": { + "description": "The name of the GitHub app", "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "Probot Owners" ] }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." ] }, - "emails": { + "external_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://example.com" ] }, - "environments": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" ] }, - "issues": { + "created_at": { "type": "string", - "enum": [ - "read", - "write" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" ] }, - "keys": { + "updated_at": { "type": "string", - "enum": [ - "read", - "write" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" ] }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" ] }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 ] }, - "organization_hooks": { + "client_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "organization_packages": { + "client_secret": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, - "organization_projects": { + "pem": { "type": "string", - "enum": [ - "read", - "write", - "admin" + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ], + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" + ] + }, + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 ] }, - "organization_self_hosted_runners": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "probot-owners" ] }, - "organization_user_blocking": { + "node_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" ] }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "pages": { + "name": { + "description": "The name of the GitHub app", "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "Probot Owners" ] }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." ] }, - "repository_hooks": { + "external_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://example.com" ] }, - "repository_projects": { + "html_url": { "type": "string", - "enum": [ - "read", - "write", - "admin" + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" ] }, - "secret_scanning_alerts": { + "created_at": { "type": "string", - "enum": [ - "read", - "write" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" ] }, - "secrets": { + "updated_at": { "type": "string", - "enum": [ - "read", - "write" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" ] }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" ] }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 ] }, - "statuses": { + "client_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "team_discussions": { + "client_secret": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, - "workflows": { + "pem": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" + "before": { + "type": [ + "string", + "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" + ] }, - "updated_at": { + "conclusion": { "type": [ "string", "null" ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], + "examples": [ + "neutral" + ] + }, + "created_at": { + "type": "string", "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "before": { - "type": [ - "string", - "null" - ] - }, - "check_runs_url": { - "type": "string", - "format": "uri" - }, - "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null, - "skipped", - "startup_failure" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "head_branch": { - "description": "The head branch name the changes are on.", - "type": [ - "string", - "null" - ] - }, - "head_commit": { - "title": "SimpleCommit", - "type": "object", - "properties": { - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" ] }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "id": { - "type": "string" - }, - "message": { - "type": "string" + "type": "integer", + "examples": [ + 5 + ] }, - "timestamp": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] }, - "tree_id": { - "type": "string" - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string" - }, - "id": { - "type": "integer" - }, - "latest_check_runs_count": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "pull_requests": { - "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", - "type": "array", - "items": { - "title": "Check Run Pull Request", - "type": "object", - "properties": { - "base": { + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", "type": "object", "properties": { - "ref": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { "type": "string" }, - "repo": { - "title": "Repo Ref", + "head": { "type": "object", "properties": { - "id": { - "type": "integer" + "ref": { + "type": "string" }, - "name": { + "sha": { "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] } }, "required": [ - "id", - "url", - "name" + "ref", + "sha", + "repo" ] }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", + "base": { "type": "object", "properties": { - "id": { - "type": "integer" + "ref": { + "type": "string" }, - "name": { + "sha": { "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] } }, "required": [ - "id", - "url", - "name" + "ref", + "sha", + "repo" ] - }, - "sha": { - "type": "string" } }, "required": [ - "ref", - "sha", - "repo" + "id", + "number", + "url", + "head", + "base" ] - }, - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" } }, - "required": [ - "url", - "id", - "number", - "head", - "base" - ] - } - }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" - }, - "status": { - "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", - "type": [ - "string", - "null" - ], - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - null, - "pending" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL that points to the check suite API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "head_branch", - "head_sha", - "status", - "conclusion", - "url", - "before", - "after", - "pull_requests", - "app", - "created_at", - "updated_at", - "latest_check_runs_count", - "check_runs_url", - "head_commit" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "key": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", "examples": [ - "mit" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ - "MIT License" + "Hello-World" ] }, - "url": { - "type": [ - "string", - "null" - ], + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "https://github.com/octocat/Hello-World" ] }, - "spdx_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "MIT" + "This your first repo!" ] }, - "node_id": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "email": { - "type": [ - "string", - "null" + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "login": { + "blobs_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "id": { - "type": "integer", + "branches_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "node_id": { + "collaborators_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "avatar_url": { + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { - "type": "boolean" + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/teams" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] + } + } + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example" + ] + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "details_url": { + "type": "string", + "examples": [ + "https://example.com" + ] + }, + "external_id": { + "type": "string", + "examples": [ + "42" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "started_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ], + "examples": [ + "queued" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -559750,6 +561355,16 @@ "updated_at" ] }, + "requested_action": { + "description": "The action requested by the user.", + "type": "object", + "properties": { + "identifier": { + "description": "The integrator reference of the action requested by the user.", + "type": "string" + } + } + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -559914,10 +561529,362 @@ }, "required": [ "action", - "check_suite", + "check_run", "repository", "sender" ] + }, + "examples": { + "default": { + "value": { + "action": "requested_action", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } + }, + "requested_action": { + "identifier": "lgtm|1234" + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Requested Action Event", + "description": "The check_run.requested_action webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } } } } @@ -559929,8 +561896,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check-suite", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -559939,13 +561907,13 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -560010,1040 +561978,2880 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert appeared_in_branch event", + "title": "Check Run Re-Requested Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "appeared_in_branch" + "rerequested" ] }, - "alert": { - "description": "The code scanning alert involved in the event.", + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "dismissed_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": [ - "string", - "null" - ], - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances": { - "type": "array", - "items": { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - } - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" + "app": { + "anyOf": [ + { + "type": "null" }, - "location": { + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - "path": { - "type": "string" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] }, - "start_column": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" ] }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", + "after": { "type": [ "string", "null" ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "tool": { - "type": "object", - "properties": { - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" ] - } - }, - "required": [ - "name", - "version" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" - ] - }, - "commit_oid": { - "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": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "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" - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" }, - { - "title": "License Simple", - "description": "License Simple", + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { - "key": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", "type": "string", "examples": [ - "mit" + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, "name": { + "description": "The name of the GitHub app", "type": "string", "examples": [ - "MIT License" + "Probot Owners" ] }, - "url": { + "description": { "type": [ "string", "null" ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "https://example.com" ] }, - "spdx_id": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { "type": [ "string", "null" ], "examples": [ - "MIT" + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, - "node_id": { + "pem": { "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" ] - }, - "html_url": { - "type": "string", - "format": "uri" } }, "required": [ - "key", + "id", + "node_id", + "owner", "name", - "url", - "spdx_id", - "node_id" + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "before": { + "type": [ + "string", + "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], + "examples": [ + "neutral" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": [ - "string", - "null" + "type": "string", + "examples": [ + "Hello-World" ] }, - "email": { + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, - "starred_at": { + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "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" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] }, - "push": { - "type": "boolean" + "updated_at": { + "type": "string", + "format": "date-time" }, - "maintain": { - "type": "boolean" + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] } - }, - "required": [ - "admin", - "pull", - "push" + } + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { + "description": "Unique identifier of the deployment", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "MDEwOkRlcGxveW1lbnQx" ] }, - "html_url": { + "task": { + "description": "Parameter to specify a task to execute", "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "deploy" ] }, - "followers_url": { + "original_environment": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "staging" ] }, - "following_url": { + "environment": { + "description": "Name for the target deployment environment.", "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "production" ] }, - "gists_url": { - "type": "string", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "Deploy request from hubot" ] }, - "starred_url": { + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "2012-07-20T01:19:13Z" ] }, - "subscriptions_url": { + "updated_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "2012-07-20T01:19:13Z" ] }, - "organizations_url": { + "statuses_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, - "repos_url": { + "repository_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://api.github.com/repos/octocat/example" ] }, - "received_events_url": { - "type": "string", - "format": "uri", + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/received_events" + true ] }, - "type": { - "type": "string", + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", "examples": [ - "User" + true ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "details_url": { + "type": "string", + "examples": [ + "https://example.com" + ] + }, + "external_id": { + "type": "string", + "examples": [ + "42" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "started_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ], + "examples": [ + "queued" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", "organizations_url", "received_events_url", "repos_url", @@ -562236,13 +566044,360 @@ } }, "required": [ - "action", - "alert", - "ref", - "commit_oid", + "check_run", "repository", "sender" ] + }, + "examples": { + "default": { + "value": { + "action": "rerequested", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "completed", + "conclusion": "success", + "started_at": "2019-05-15T15:21:12Z", + "completed_at": "2019-05-15T15:21:45Z", + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "completed", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Re-Requested Event", + "description": "The check_run.rerequested webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } } } } @@ -562254,8 +566409,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code-scanning-alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -562264,13 +566420,13 @@ } } }, - "code-scanning-alert-closed-by-user": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" }, "parameters": [ { @@ -562335,430 +566491,796 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert closed_by_user event", + "title": "check_suite completed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed_by_user" + "completed" ] }, - "alert": { - "description": "The code scanning alert involved in the event.", + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#suites).", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", - "format": "date-time" - }, - "dismissed_by": { - "title": "User", + "after": { "type": [ - "object", + "string", "null" - ], + ] + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_group", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "projects_v2_item", + "secret_scanning_alert_location" + ] + } }, - "followers_url": { - "type": "string", + "external_url": { + "type": [ + "string", + "null" + ], "format": "uri" }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, "html_url": { "type": "string", "format": "uri" }, "id": { - "type": "integer" - }, - "login": { - "type": "string" + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] }, "name": { + "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "login", - "id" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "before": { "type": [ "string", "null" - ], - "enum": [ - "false positive", - "won't fix", - "used in tests", - null ] }, - "html_url": { - "description": "The GitHub URL of the alert resource.", + "check_runs_url": { "type": "string", "format": "uri" }, - "instances": { + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", "type": "array", "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "ref": { "type": "string" }, - "location": { + "repo": { + "title": "Repo Ref", "type": "object", "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { + "id": { "type": "integer" }, - "path": { + "name": { "type": "string" }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" + "url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "id", + "url", + "name" + ] }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", + "sha": { "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] } }, "required": [ "ref", - "analysis_key", - "environment", - "state" + "sha", + "repo" ] }, - { + "head": { "type": "object", "properties": { - "state": { - "type": "string", - "enum": [ - "dismissed" + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" ] + }, + "sha": { + "type": "string" } }, "required": [ - "state" + "ref", + "sha", + "repo" ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" ] } }, - "most_recent_instance": { - "title": "Alert Instance", + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", "type": [ - "object", + "string", "null" ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": [ - "string", - "null" - ] - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": [ - "string", - "null" - ] - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": [ - "string", - "null" - ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", "enum": [ - "dismissed", - "fixed" + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" ] }, - "tool": { - "type": "object", - "properties": { - "guid": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "version" - ] + "updated_at": { + "type": "string", + "format": "date-time" }, "url": { + "description": "URL that points to the check suite API resource.", "type": "string", "format": "uri" } }, "required": [ - "number", - "created_at", + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -562973,10 +567495,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -564610,9 +569128,7 @@ }, "required": [ "action", - "alert", - "ref", - "commit_oid", + "check_suite", "repository", "sender" ] @@ -564628,7 +569144,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code-scanning-alert", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -564637,13 +569153,13 @@ } } }, - "code-scanning-alert-created": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" }, "parameters": [ { @@ -564708,362 +569224,795 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert created event", + "title": "check_suite requested event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "requested" ] }, - "alert": { - "description": "The code scanning alert involved in the event.", + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#suites).", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": [ - "null" - ] - }, - "dismissed_by": { - "type": [ - "null" - ] - }, - "dismissed_comment": { + "after": { "type": [ "string", "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": [ - "null" ] }, - "fixed_at": { - "type": [ - "null" - ] - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances": { - "type": "array", - "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - { - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "open", - "dismissed" - ] - } - }, - "required": [ - "state" - ] - } - ] - } - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "classifications": { + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "secret_scanning_alert_location", + "projects_v2_item", + "merge_group", + "repository_import" + ] } }, - "commit_sha": { + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", "type": "string" }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "node_id": { "type": "string" }, - "location": { - "type": "object", + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "end_column": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri" }, - "end_line": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "path": { + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "start_column": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" }, - "start_line": { + "id": { "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] }, - "message": { + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "text": { - "type": "string" + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] } } }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", + "slug": { + "description": "The slug name of the GitHub app", "type": "string" }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "ref", - "analysis_key", - "environment", - "state" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" + "before": { + "type": [ + "string", + "null" + ] }, - "rule": { + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", "type": "object", "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": [ - "string", - "null" + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" ] }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": [ - "string", - "null" + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" ] }, "id": { - "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, - "name": { + "message": { "type": "string" }, - "severity": { - "description": "The severity of the alert.", - "type": [ - "string", - "null" - ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] + "timestamp": { + "type": "string" }, - "tags": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "tree_id": { + "type": "string" } }, "required": [ "id", - "severity", - "description" + "tree_id", + "message", + "timestamp", + "author", + "committer" ] }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed" - ] + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" }, - "tool": { - "type": [ - "object", - "null" - ], - "properties": { - "guid": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "version" - ] + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } }, - "updated_at": { + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", "type": [ "string", "null" + ], + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null ] }, + "updated_at": { + "type": "string", + "format": "date-time" + }, "url": { + "description": "URL that points to the check suite API resource.", "type": "string", "format": "uri" } }, "required": [ - "number", - "created_at", + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -565278,10 +570227,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -566915,9 +571860,7 @@ }, "required": [ "action", - "alert", - "ref", - "commit_oid", + "check_suite", "repository", "sender" ] @@ -566933,7 +571876,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code-scanning-alert", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -566942,13 +571885,13 @@ } } }, - "code-scanning-alert-fixed": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" }, "parameters": [ { @@ -567013,436 +571956,805 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert fixed event", + "title": "check_suite rerequested event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "fixed" + "rerequested" ] }, - "alert": { - "description": "The code scanning alert involved in the event.", + "actions_meta": { + "type": [ + "object", + "null" + ], + "properties": { + "rerun_info": { + "type": "object", + "properties": { + "plan_id": { + "type": "string" + }, + "job_ids": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#suites).", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "after": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "dismissed_by": { - "title": "User", - "type": [ - "object", - "null" - ], + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job" + ] + } }, - "followers_url": { - "type": "string", + "external_url": { + "type": [ + "string", + "null" + ], "format": "uri" }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, "html_url": { "type": "string", "format": "uri" }, "id": { - "type": "integer" - }, - "login": { - "type": "string" + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] }, "name": { + "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "login", - "id" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "before": { + "type": [ + "string", + "null" + ] + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", "type": [ "string", "null" ], "enum": [ - "false positive", - "won't fix", - "used in tests", + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", null ] }, - "html_url": { - "description": "The GitHub URL of the alert resource.", + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "instances": { + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", "type": "array", "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "ref": { "type": "string" }, - "location": { + "repo": { + "title": "Repo Ref", "type": "object", "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { + "id": { "type": "integer" }, - "path": { + "name": { "type": "string" }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" + "url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "id", + "url", + "name" + ] }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", + "sha": { "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] } }, "required": [ "ref", - "analysis_key", - "environment", - "state" + "sha", + "repo" ] }, - { + "head": { "type": "object", "properties": { - "state": { - "type": "string", - "enum": [ - "fixed" + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" ] + }, + "sha": { + "type": "string" } }, "required": [ - "state" + "ref", + "sha", + "repo" ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" ] } }, - "instances_url": { - "type": "string", - "format": "uri" + "rerequestable": { + "type": "boolean" }, - "most_recent_instance": { - "title": "Alert Instance", + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", "type": [ - "object", + "string", "null" ], - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": [ - "string", - "null" - ] - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": [ - "string", - "null" - ] - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": [ - "string", - "null" - ], - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", "enum": [ - "fixed" + "requested", + "in_progress", + "completed", + "queued", + null ] }, - "tool": { - "type": "object", - "properties": { - "guid": { - "type": [ - "string", - "null" - ] - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "version" - ] + "updated_at": { + "type": "string", + "format": "date-time" }, "url": { + "description": "URL that points to the check suite API resource.", "type": "string", "format": "uri" } }, "required": [ - "number", - "created_at", + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -567657,10 +572969,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -569294,9 +574602,7 @@ }, "required": [ "action", - "alert", - "ref", - "commit_oid", + "check_suite", "repository", "sender" ] @@ -569312,7 +574618,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code-scanning-alert", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -569321,11 +574627,11 @@ } } }, - "code-scanning-alert-reopened": { + "code-scanning-alert-appeared-in-branch": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, @@ -569392,21 +574698,18 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened event", + "title": "code_scanning_alert appeared_in_branch event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "appeared_in_branch" ] }, "alert": { "description": "The code scanning alert involved in the event.", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "created_at": { "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", @@ -569418,12 +574721,103 @@ "type": [ "string", "null" - ] + ], + "format": "date-time" }, "dismissed_by": { + "title": "User", "type": [ "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, "dismissed_reason": { @@ -569431,6 +574825,12 @@ "type": [ "string", "null" + ], + "enum": [ + "false positive", + "won't fix", + "used in tests", + null ] }, "html_url": { @@ -569441,94 +574841,76 @@ "instances": { "type": "array", "items": { - "allOf": [ - { - "title": "Alert Instance", - "type": [ - "object", - "null" - ], + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } + "end_column": { + "type": "integer" }, - "commit_sha": { - "type": "string" + "end_line": { + "type": "integer" }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "path": { "type": "string" }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" + "start_column": { + "type": "integer" }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] + "start_line": { + "type": "integer" } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] + } }, - { + "message": { "type": "object", "properties": { - "state": { - "type": "string", - "enum": [ - "open" - ] + "text": { + "type": "string" } - }, - "required": [ - "state" + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" ] } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" ] } }, @@ -569616,29 +574998,10 @@ "description": "A short description of the rule used to detect the alert.", "type": "string" }, - "full_description": { - "type": "string" - }, - "help": { - "type": [ - "string", - "null" - ] - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": [ - "string", - "null" - ] - }, "id": { "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, - "name": { - "type": "string" - }, "severity": { "description": "The severity of the alert.", "type": [ @@ -569652,15 +575015,6 @@ "error", null ] - }, - "tags": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } } }, "required": [ @@ -569681,12 +575035,6 @@ "tool": { "type": "object", "properties": { - "guid": { - "type": [ - "string", - "null" - ] - }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -569724,10 +575072,7 @@ }, "commit_oid": { "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", - "null" - ] + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -569945,10 +575290,7 @@ }, "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", - "null" - ] + "type": "string" }, "repository": { "title": "Repository", @@ -571610,11 +576952,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-closed-by-user": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, @@ -571681,13 +577023,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened_by_user event", + "title": "code_scanning_alert closed_by_user event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened_by_user" + "closed_by_user" ] }, "alert": { @@ -571701,19 +577043,116 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": [ - "null" - ] + "type": "string", + "format": "date-time" }, "dismissed_by": { + "title": "User", "type": [ + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "type": [ + "string", "null" + ], + "enum": [ + "false positive", + "won't fix", + "used in tests", + null ] }, "html_url": { @@ -571804,7 +577243,7 @@ "state": { "type": "string", "enum": [ - "open" + "dismissed" ] } }, @@ -571899,10 +577338,29 @@ "description": "A short description of the rule used to detect the alert.", "type": "string" }, + "full_description": { + "type": "string" + }, + "help": { + "type": [ + "string", + "null" + ] + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] + }, "id": { "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, + "name": { + "type": "string" + }, "severity": { "description": "The severity of the alert.", "type": [ @@ -571916,6 +577374,15 @@ "error", null ] + }, + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } } }, "required": [ @@ -571928,13 +577395,19 @@ "description": "State of a code scanning alert.", "type": "string", "enum": [ - "open", + "dismissed", "fixed" ] }, "tool": { "type": "object", "properties": { + "guid": { + "type": [ + "string", + "null" + ] + }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -573852,13 +579325,13 @@ } } }, - "commit-comment-created": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -573923,248 +579396,362 @@ "content": { "application/json": { "schema": { - "title": "commit_comment created event", + "title": "code_scanning_alert created event", "type": "object", "properties": { "action": { - "description": "The action performed. Can be `created`.", "type": "string", "enum": [ "created" ] }, - "comment": { - "description": "The [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-a-commit-comment) resource.", + "alert": { + "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "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" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the commit comment.", - "type": "integer" + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": [ - "integer", "null" ] }, - "node_id": { - "description": "The node ID of the commit comment.", - "type": "string" + "dismissed_by": { + "type": [ + "null" + ] }, - "path": { - "description": "The relative path of the file to which the comment applies.", + "dismissed_comment": { "type": [ "string", "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "null" ] }, - "position": { - "description": "The line index in the diff to which the comment applies.", + "fixed_at": { "type": [ - "integer", "null" ] }, - "reactions": { - "title": "Reactions", - "type": "object", + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "open", + "dismissed" + ] + } + }, + "required": [ + "state" + ] + } + ] + } + }, + "instances_url": { + "type": "string" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" }, - "eyes": { - "type": "integer" + "classifications": { + "type": "array", + "items": { + "type": "string" + } }, - "heart": { - "type": "integer" + "commit_sha": { + "type": "string" }, - "hooray": { - "type": "integer" + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" }, - "laugh": { - "type": "integer" + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } }, - "rocket": { - "type": "integer" + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } }, - "total_count": { - "type": "integer" + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" }, - "url": { + "state": { + "description": "State of a code scanning alert.", "type": "string", - "format": "uri" + "enum": [ + "open", + "dismissed", + "fixed" + ] } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "ref", + "analysis_key", + "environment", + "state" ] }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" + "number": { + "description": "The code scanning alert number.", + "type": "integer" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], + "rule": { + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" }, - "deleted": { - "type": "boolean" + "full_description": { + "type": "string" }, - "email": { + "help": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] }, "id": { - "type": "integer" - }, - "login": { + "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, "name": { "type": "string" }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "severity": { + "description": "The severity of the alert.", + "type": [ + "string", + "null" + ], + "enum": [ + "none", + "note", + "warning", + "error", + null + ] }, - "starred_url": { - "type": "string", - "format": "uri-template" + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed" + ] + }, + "tool": { + "type": [ + "object", + "null" + ], + "properties": { + "guid": { + "type": [ + "string", + "null" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "version": { + "description": "The version of the tool used to detect the alert.", + "type": [ + "string", + "null" ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ - "login", - "id" + "name", + "version" ] + }, + "updated_at": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ + "number", + "created_at", "url", "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "created_at", - "updated_at", - "author_association", - "body" + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" ] }, + "commit_oid": { + "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -574379,6 +579966,10 @@ "description" ] }, + "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" + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -576012,7 +581603,9 @@ }, "required": [ "action", - "comment", + "alert", + "ref", + "commit_oid", "repository", "sender" ] @@ -576028,7 +581621,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit-comment", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -576037,12 +581630,13 @@ } } }, - "create": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are created at once.", - "operationId": "create", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -576107,16 +581701,436 @@ "content": { "application/json": { "schema": { - "title": "create event", + "title": "code_scanning_alert fixed event", "type": "object", "properties": { - "description": { - "description": "The repository's current description.", - "type": [ - "string", - "null" + "action": { + "type": "string", + "enum": [ + "fixed" ] }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "string", + "null" + ], + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "fixed" + ] + } + }, + "required": [ + "state" + ] + } + ] + } + }, + "instances_url": { + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": [ + "string", + "null" + ] + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": [ + "string", + "null" + ], + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -576232,10 +582246,6 @@ "node_id" ] }, - "master_branch": { - "description": "The name of the repository's default branch (usually `main`).", - "type": "string" - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -576335,22 +582345,10 @@ "description" ] }, - "pusher_type": { - "description": "The pusher type for the event. Can be either `user` or a deploy key.", - "type": "string" - }, "ref": { - "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/reference/git#get-a-reference) resource.", + "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" }, - "ref_type": { - "description": "The type of Git ref object created in the repository.", - "type": "string", - "enum": [ - "tag", - "branch" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -577983,11 +583981,10 @@ } }, "required": [ + "action", + "alert", "ref", - "ref_type", - "master_branch", - "description", - "pusher_type", + "commit_oid", "repository", "sender" ] @@ -578003,7 +584000,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -578012,12 +584009,13 @@ } } }, - "delete": { + "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -578082,9 +584080,343 @@ "content": { "application/json": { "schema": { - "title": "delete event", + "title": "code_scanning_alert reopened event", "type": "object", "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": [ + "string", + "null" + ] + }, + "dismissed_by": { + "type": [ + "object", + "null" + ] + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "open" + ] + } + }, + "required": [ + "state" + ] + } + ] + } + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": [ + "string", + "null" + ] + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": [ + "string", + "null" + ] + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": [ + "string", + "null" + ], + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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", + "null" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -578299,20 +584631,11 @@ "description" ] }, - "pusher_type": { - "description": "The pusher type for the event. Can be either `user` or a deploy key.", - "type": "string" - }, "ref": { - "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/reference/git#get-a-reference) resource.", - "type": "string" - }, - "ref_type": { - "description": "The type of Git ref object deleted in the repository.", - "type": "string", - "enum": [ - "tag", - "branch" + "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", + "null" ] }, "repository": { @@ -579947,9 +586270,10 @@ } }, "required": [ + "action", + "alert", "ref", - "ref_type", - "pusher_type", + "commit_oid", "repository", "sender" ] @@ -579965,7 +586289,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -579974,13 +586298,13 @@ } } }, - "dependabot-alert-created": { + "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert" }, "parameters": [ { @@ -580045,665 +586369,388 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert created event", + "title": "code_scanning_alert reopened_by_user event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "reopened_by_user" ] }, "alert": { + "description": "The code scanning alert involved in the event.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "dismissed", - "fixed", - "open" + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": [ + "null" ] }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } + "dismissed_by": { + "type": [ + "null" + ] }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": [ + "null" + ] + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances": { + "type": "array", + "items": { + "allOf": [ + { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], "properties": { - "package": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true + "end_column": { + "type": "integer" }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true + } }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, + "message": { + "type": "object", "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true + "text": { + "type": "string" } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true + } }, - "name": { + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true + "enum": [ + "open", + "dismissed", + "fixed" + ] } }, "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { + "ref", + "analysis_key", + "environment", + "state" + ] + }, + { "type": "object", - "description": "An advisory identifier.", - "readOnly": true, "properties": { - "type": { + "state": { "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, "enum": [ - "CVE", - "GHSA" + "open" ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true } }, "required": [ - "value", - "type" - ], - "additionalProperties": false + "state" + ] } + ] + } + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": [ + "object", + "null" + ], + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" }, - "references": { + "classifications": { "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" }, - "required": [ - "url" - ], - "additionalProperties": false + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } } }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } }, - "updated_at": { + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" }, - "withdrawn_at": { + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", "type": [ "string", "null" ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "enum": [ + "none", + "note", + "warning", + "error", + null + ] } }, "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", + "id", "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false + "description" + ] }, - "security_vulnerability": { + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "fixed" + ] + }, + "tool": { "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" }, - "first_patched_version": { + "version": { + "description": "The version of the tool used to detect the alert.", "type": [ - "object", + "string", "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false + ] } }, "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false + "name", + "version" + ] }, "url": { "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, "html_url": { "type": "string", - "description": "The GitHub URL of the alert resource.", "format": "uri", - "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 + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "dismissed_at": { + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 ] }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "dismissed_comment": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { "type": [ "string", "null" ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "fixed_at": { + "updated_at": { "type": [ "string", "null" ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -580829,95 +586876,9 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + "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" }, "repository": { "title": "Repository", @@ -582553,6 +588514,8 @@ "required": [ "action", "alert", + "ref", + "commit_oid", "repository", "sender" ] @@ -582568,7 +588531,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "code-scanning-alert", "supported-webhook-types": [ "repository", "organization", @@ -582577,13 +588540,13 @@ } } }, - "dependabot-alert-dismissed": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment" }, "parameters": [ { @@ -582648,665 +588611,337 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert dismissed event", + "title": "commit_comment created event", "type": "object", "properties": { "action": { + "description": "The action performed. Can be `created`.", "type": "string", "enum": [ - "dismissed" + "created" ] }, - "alert": { + "comment": { + "description": "The [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-a-commit-comment) resource.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, "enum": [ - "dismissed", - "fixed", - "open" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "dependency": { + "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" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the commit comment.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the commit comment.", + "type": "string" + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": [ + "string", + "null" + ] + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "reactions": { + "title": "Reactions", "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false + "+1": { + "type": "integer" }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true + "-1": { + "type": "integer" }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] + "confused": { + "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" + ] }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "ghsa_id": { + "avatar_url": { "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true + "format": "uri" }, - "cve_id": { + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true + ] }, - "summary": { + "events_url": { "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 + "format": "uri-template" }, - "description": { + "followers_url": { "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true + "format": "uri" }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } + "following_url": { + "type": "string", + "format": "uri-template" }, - "severity": { + "gists_url": { "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "format": "uri-template" }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false + "gravatar_id": { + "type": "string" }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } + "html_url": { + "type": "string", + "format": "uri" }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } + "id": { + "type": "integer" }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } + "login": { + "type": "string" }, - "published_at": { + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "updated_at": { + "received_events_url": { "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false + "repos_url": { + "type": "string", + "format": "uri" }, - "severity": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, "enum": [ - "low", - "medium", - "high", - "critical" + "Bot", + "User", + "Organization" ] }, - "vulnerable_version_range": { + "url": { "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false + "format": "uri" } }, "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "id", + "node_id", + "user", + "position", + "line", + "path", + "commit_id", + "created_at", + "updated_at", + "author_association", + "body" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, "html_url": { "type": "string", - "description": "The GitHub URL of the alert resource.", "format": "uri", - "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 + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "dismissed_at": { + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri" }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 ] }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "dismissed_comment": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { "type": [ "string", "null" ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "fixed_at": { + "updated_at": { "type": [ "string", "null" ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -583432,96 +589067,6 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -585155,7 +590700,7 @@ }, "required": [ "action", - "alert", + "comment", "repository", "sender" ] @@ -585171,7 +590716,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "commit-comment", "supported-webhook-types": [ "repository", "organization", @@ -585180,13 +590725,12 @@ } } }, - "dependabot-alert-fixed": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are created at once.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -585251,665 +590795,105 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert fixed event", + "title": "create event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "fixed" + "description": { + "description": "The repository's current description.", + "type": [ + "string", + "null" ] }, - "alert": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "state": { + "html_url": { "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "dismissed", - "fixed", - "open" + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" ] }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" ], - "additionalProperties": false + "format": "uri" }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "html_url": { + "node_id": { "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "created_at": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "examples": [ + "Octo Business" + ] }, - "updated_at": { + "slug": { + "description": "The slug url identifier for the enterprise.", "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 + "examples": [ + "octo-business" + ] }, - "dismissed_at": { + "created_at": { "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "2019-01-26T19:01:12Z" ] }, - "dismissed_reason": { + "updated_at": { "type": [ "string", "null" ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -585936,6 +590920,10 @@ "node_id" ] }, + "master_branch": { + "description": "The name of the repository's default branch (usually `main`).", + "type": "string" + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -586035,94 +591023,20 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "pusher_type": { + "description": "The pusher type for the event. Can be either `user` or a deploy key.", + "type": "string" + }, + "ref": { + "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/reference/git#get-a-reference) resource.", + "type": "string" + }, + "ref_type": { + "description": "The type of Git ref object created in the repository.", + "type": "string", + "enum": [ + "tag", + "branch" ] }, "repository": { @@ -587757,8 +592671,11 @@ } }, "required": [ - "action", - "alert", + "ref", + "ref_type", + "master_branch", + "description", + "pusher_type", "repository", "sender" ] @@ -587774,7 +592691,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "create", "supported-webhook-types": [ "repository", "organization", @@ -587783,13 +592700,12 @@ } } }, - "dependabot-alert-reintroduced": { + "delete": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when a Git branch or tag is deleted.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -587854,665 +592770,98 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert reintroduced event", + "title": "delete event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "reintroduced" - ] - }, - "alert": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "A Dependabot alert.", "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "state": { + "html_url": { "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "dismissed", - "fixed", - "open" + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" ] }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": [ - "string", - "null" - ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": [ - "object", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" ], - "additionalProperties": false + "format": "uri" }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "html_url": { + "node_id": { "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "created_at": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "examples": [ + "Octo Business" + ] }, - "updated_at": { + "slug": { + "description": "The slug url identifier for the enterprise.", "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 + "examples": [ + "octo-business" + ] }, - "dismissed_at": { + "created_at": { "type": [ "string", "null" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "2019-01-26T19:01:12Z" ] }, - "dismissed_reason": { + "updated_at": { "type": [ "string", "null" ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", + "id", + "node_id", + "name", + "slug", "html_url", "created_at", "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at" - ], - "additionalProperties": false + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -588638,94 +592987,20 @@ "description" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "pusher_type": { + "description": "The pusher type for the event. Can be either `user` or a deploy key.", + "type": "string" + }, + "ref": { + "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/reference/git#get-a-reference) resource.", + "type": "string" + }, + "ref_type": { + "description": "The type of Git ref object deleted in the repository.", + "type": "string", + "enum": [ + "tag", + "branch" ] }, "repository": { @@ -590360,8 +594635,9 @@ } }, "required": [ - "action", - "alert", + "ref", + "ref_type", + "pusher_type", "repository", "sender" ] @@ -590377,7 +594653,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot-alert", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -590386,11 +594662,11 @@ } } }, - "dependabot-alert-reopened": { + "dependabot-alert-created": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, @@ -590457,13 +594733,13 @@ "content": { "application/json": { "schema": { - "title": "Dependabot alert reopened event", + "title": "Dependabot alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "created" ] }, "alert": { @@ -592989,13 +597265,13 @@ } } }, - "deploy-key-created": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -593060,104 +597336,665 @@ "content": { "application/json": { "schema": { - "title": "deploy_key created event", + "title": "Dependabot alert dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "dismissed" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "alert": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "html_url": { + "state": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], - "format": "uri" + "additionalProperties": false }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "name": { - "description": "The name of the enterprise.", + "html_url": { "type": "string", - "examples": [ - "Octo Business" - ] + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "created_at": { "type": "string", - "examples": [ - "octo-business" - ] + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "created_at": { + "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 + }, + "dismissed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "updated_at": { + "dismissed_reason": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -593184,55 +598021,6 @@ "node_id" ] }, - "key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#get-a-deploy-key) resource.", - "type": "object", - "properties": { - "added_by": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "last_used": { - "type": [ - "string", - "null" - ] - }, - "read_only": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "verified": { - "type": "boolean" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -593332,6 +598120,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -594965,7 +599843,7 @@ }, "required": [ "action", - "key", + "alert", "repository", "sender" ] @@ -594981,7 +599859,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy-key", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -594990,13 +599868,13 @@ } } }, - "deploy-key-deleted": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -595061,104 +599939,665 @@ "content": { "application/json": { "schema": { - "title": "deploy_key deleted event", + "title": "Dependabot alert fixed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "fixed" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "alert": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "html_url": { + "state": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], - "format": "uri" + "additionalProperties": false }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "name": { - "description": "The name of the enterprise.", + "html_url": { "type": "string", - "examples": [ - "Octo Business" - ] + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "created_at": { "type": "string", - "examples": [ - "octo-business" - ] + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "created_at": { + "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 + }, + "dismissed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "updated_at": { + "dismissed_reason": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -595185,55 +600624,6 @@ "node_id" ] }, - "key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#get-a-deploy-key) resource.", - "type": "object", - "properties": { - "added_by": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "last_used": { - "type": [ - "string", - "null" - ] - }, - "read_only": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "verified": { - "type": "boolean" - } - }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -595333,6 +600723,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -596966,7 +602446,7 @@ }, "required": [ "action", - "key", + "alert", "repository", "sender" ] @@ -596982,7 +602462,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy-key", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -596991,13 +602471,13 @@ } } }, - "deployment-created": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -597062,761 +602542,665 @@ "content": { "application/json": { "schema": { - "title": "deployment created event", + "title": "Dependabot alert reintroduced event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "reintroduced" ] }, - "deployment": { - "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployments).", + "alert": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "created_at": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "deleted": { - "type": "boolean" + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true }, - "email": { + "scope": { "type": [ "string", "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { "type": "string", - "format": "uri" + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "following_url": { - "type": "string", - "format": "uri-template" + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true }, - "gists_url": { + "summary": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 }, - "html_url": { + "description": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true }, - "node_id": { - "type": "string" + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } }, - "organizations_url": { + "severity": { "type": "string", - "format": "uri" + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, - "received_events_url": { - "type": "string", - "format": "uri" + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false }, - "repos_url": { - "type": "string", - "format": "uri" + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } }, - "site_admin": { - "type": "boolean" + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } }, - "subscriptions_url": { + "published_at": { "type": "string", - "format": "uri" + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "type": { + "updated_at": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "url": { - "type": "string", - "format": "uri" + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "environment": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - } - ] - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "workflow_job", - "pull_request_review_thread", - "merge_queue_entry", - "secret_scanning_alert_location", - "merge_group" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" ], - "format": "uri" + "additionalProperties": false }, - "html_url": { + "severity": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true }, - "owner": { - "title": "User", + "first_patched_version": { "type": [ "object", "null" ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { + "identifier": { "type": "string", - "format": "uri" + "description": "The package version that patches this vulnerability.", + "readOnly": true } }, "required": [ - "login", - "id" - ] + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "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 + }, + "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 + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" + "name": { + "type": [ + "string", + "null" ] }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "organization_plan": { + "login": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "octocat" ] }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "organization_secrets": { + "node_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "organization_self_hosted_runners": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "packages": { + "url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "pages": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "pull_requests": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "repository_hooks": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "repository_projects": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "secret_scanning_alerts": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "secrets": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "security_events": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "security_scanning_alert": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, - "single_file": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "statuses": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "team_discussions": { + "type": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "User" ] }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "workflows": { + "starred_at": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "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" + ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" ] }, - "website_url": { - "description": "The enterprise's website URL.", + "dismissed_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "created_at": { + "dismissed_comment": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 }, - "updated_at": { + "fixed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -597942,6 +603326,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -599571,937 +605045,11 @@ "type", "url" ] - }, - "workflow": { - "title": "Workflow", - "type": [ - "object", - "null" - ], - "properties": { - "badge_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "badge_url", - "created_at", - "html_url", - "id", - "name", - "node_id", - "path", - "state", - "updated_at", - "url" - ] - }, - "workflow_run": { - "title": "Deployment Workflow Run", - "type": [ - "object", - "null" - ], - "properties": { - "actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "artifacts_url": { - "type": "string" - }, - "cancel_url": { - "type": "string" - }, - "check_suite_id": { - "type": "integer" - }, - "check_suite_node_id": { - "type": "string" - }, - "check_suite_url": { - "type": "string" - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "display_title": { - "type": "string" - }, - "event": { - "type": "string" - }, - "head_branch": { - "type": "string" - }, - "head_commit": { - "type": [ - "null" - ] - }, - "head_repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "head_sha": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "jobs_url": { - "type": "string" - }, - "logs_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "previous_attempt_url": { - "type": [ - "null" - ] - }, - "pull_requests": { - "type": "array", - "items": { - "title": "Check Run Pull Request", - "type": "object", - "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "number", - "head", - "base" - ] - } - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "rerun_url": { - "type": "string" - }, - "run_attempt": { - "type": "integer" - }, - "run_number": { - "type": "integer" - }, - "run_started_at": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - "triggering_actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "workflow_id": { - "type": "integer" - }, - "workflow_url": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_branch", - "head_sha", - "run_number", - "event", - "status", - "conclusion", - "workflow_id", - "check_suite_id", - "check_suite_node_id", - "url", - "html_url", - "path", - "pull_requests", - "created_at", - "updated_at", - "actor", - "run_attempt", - "run_started_at", - "display_title" - ] } }, "required": [ "action", - "deployment", - "workflow", - "workflow_run", + "alert", "repository", "sender" ] @@ -600517,7 +605065,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -600526,13 +605074,13 @@ } } }, - "deployment-status-created": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert" }, "parameters": [ { @@ -600597,1497 +605145,665 @@ "content": { "application/json": { "schema": { - "title": "deployment_status created event", + "title": "Dependabot alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "reopened" ] }, - "check_run": { - "type": [ - "object", - "null" - ], + "alert": { + "type": "object", + "description": "A Dependabot alert.", "properties": { - "completed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - "skipped", - null - ] - }, - "details_url": { - "type": "string", - "format": "uri" - }, - "external_id": { - "type": "string" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "The id of the check.", - "type": "integer" - }, - "name": { - "description": "The name of the check run.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "started_at": { - "type": "string", - "format": "date-time" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "status": { - "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`.", + "state": { "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "pending" + "dismissed", + "fixed", + "open" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_sha", - "external_id", - "url", - "html_url", - "details_url", - "status", - "conclusion", - "started_at", - "completed_at" - ] - }, - "deployment": { - "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployments).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "deleted": { - "type": "boolean" + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true }, - "email": { + "scope": { "type": [ "string", "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { "type": "string", - "format": "uri" + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "following_url": { - "type": "string", - "format": "uri-template" + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true }, - "gists_url": { + "summary": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 }, - "html_url": { + "description": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true }, - "node_id": { - "type": "string" + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } }, - "organizations_url": { + "severity": { "type": "string", - "format": "uri" + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, - "received_events_url": { - "type": "string", - "format": "uri" + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false }, - "repos_url": { - "type": "string", - "format": "uri" + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } }, - "site_admin": { - "type": "boolean" + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } }, - "subscriptions_url": { + "published_at": { "type": "string", - "format": "uri" + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "type": { + "updated_at": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "url": { - "type": "string", - "format": "uri" + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "environment": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "original_environment": { - "type": "string" - }, - "payload": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" ], - "type": [ - "null", - "string", - "object" - ] + "additionalProperties": false }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "merge_queue_entry", - "workflow_job", - "pull_request_review_thread", - "secret_scanning_alert_location", - "merge_group" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" ], - "format": "uri" + "additionalProperties": false }, - "html_url": { + "severity": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true }, - "owner": { - "title": "User", + "first_patched_version": { "type": [ "object", "null" ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { + "identifier": { "type": "string", - "format": "uri" + "description": "The package version that patches this vulnerability.", + "readOnly": true } }, "required": [ - "login", - "id" - ] + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "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 + }, + "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 + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" + "name": { + "type": [ + "string", + "null" ] }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "organization_administration": { + "login": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "octocat" ] }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "organization_packages": { + "node_id": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "organization_plan": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "organization_secrets": { + "url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "organization_self_hosted_runners": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "organization_user_blocking": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "packages": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "pages": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "pull_requests": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "repository_hooks": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "repository_projects": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "secret_scanning_alerts": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, - "secrets": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "security_events": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "security_scanning_alert": { + "type": { "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "User" ] }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "statuses": { + "starred_at": { "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.", - "type": "string" - }, - "target_url": { - "description": "The optional link added to the status.", - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "state", - "creator", - "description", - "environment", - "target_url", - "created_at", - "updated_at", - "deployment_url", - "repository_url" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", + "dismissed_reason": { "type": [ "string", "null" ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "created_at": { + "dismissed_comment": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 }, - "updated_at": { + "fixed_at": { "type": [ "string", "null" ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" + "readOnly": true } }, "required": [ - "id", - "node_id", - "name", - "slug", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", "html_url", "created_at", "updated_at", - "avatar_url" - ] + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false }, "installation": { "title": "Simple Installation", @@ -602213,6 +605929,96 @@ "description" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -603842,938 +607648,11 @@ "type", "url" ] - }, - "workflow": { - "title": "Workflow", - "type": [ - "object", - "null" - ], - "properties": { - "badge_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "state": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "badge_url", - "created_at", - "html_url", - "id", - "name", - "node_id", - "path", - "state", - "updated_at", - "url" - ] - }, - "workflow_run": { - "title": "Deployment Workflow Run", - "type": [ - "object", - "null" - ], - "properties": { - "actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "artifacts_url": { - "type": "string" - }, - "cancel_url": { - "type": "string" - }, - "check_suite_id": { - "type": "integer" - }, - "check_suite_node_id": { - "type": "string" - }, - "check_suite_url": { - "type": "string" - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null, - "startup_failure" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "display_title": { - "type": "string" - }, - "event": { - "type": "string" - }, - "head_branch": { - "type": "string" - }, - "head_commit": { - "type": [ - "null" - ] - }, - "head_repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "head_sha": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "jobs_url": { - "type": "string" - }, - "logs_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "previous_attempt_url": { - "type": [ - "null" - ] - }, - "pull_requests": { - "type": "array", - "items": { - "title": "Check Run Pull Request", - "type": "object", - "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "repo": { - "title": "Repo Ref", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "url", - "name" - ] - }, - "sha": { - "type": "string" - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "number", - "head", - "base" - ] - } - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - } - }, - "required": [ - "path", - "sha" - ] - } - }, - "repository": { - "type": "object", - "properties": { - "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" - }, - "description": { - "type": [ - "null" - ] - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_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" - }, - "url": { - "type": "string" - } - } - }, - "rerun_url": { - "type": "string" - }, - "run_attempt": { - "type": "integer" - }, - "run_number": { - "type": "integer" - }, - "run_started_at": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] - }, - "triggering_actor": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "workflow_id": { - "type": "integer" - }, - "workflow_url": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_branch", - "head_sha", - "run_number", - "event", - "status", - "conclusion", - "workflow_id", - "check_suite_id", - "check_suite_node_id", - "url", - "html_url", - "path", - "pull_requests", - "created_at", - "updated_at", - "actor", - "triggering_actor", - "run_attempt", - "run_started_at", - "display_title" - ] } }, "required": [ "action", - "deployment_status", - "deployment", + "alert", "repository", "sender" ] @@ -604789,7 +607668,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment-status", + "subcategory": "dependabot-alert", "supported-webhook-types": [ "repository", "organization", @@ -604798,13 +607677,13 @@ } } }, - "discussion-answered": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" }, "parameters": [ { @@ -604869,923 +607748,13 @@ "content": { "application/json": { "schema": { - "title": "discussion answered event", + "title": "deploy_key created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "answered" - ] - }, - "answer": { - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { - "type": [ - "null" - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body" - ] - }, - "discussion": { - "allOf": [ - { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": "string", - "format": "date-time" - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "type": "string" - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean", - "enum": [ - true - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - }, - "required": [ - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by" - ] - } + "created" ] }, "enterprise": { @@ -605903,6 +607872,55 @@ "node_id" ] }, + "key": { + "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#get-a-deploy-key) resource.", + "type": "object", + "properties": { + "added_by": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "last_used": { + "type": [ + "string", + "null" + ] + }, + "read_only": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "verified": { + "type": "boolean" + } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -607635,8 +609653,7 @@ }, "required": [ "action", - "discussion", - "answer", + "key", "repository", "sender" ] @@ -607652,7 +609669,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy-key", "supported-webhook-types": [ "repository", "organization", @@ -607661,13 +609678,13 @@ } } }, - "discussion-category-changed": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key" }, "parameters": [ { @@ -607732,540 +609749,82 @@ "content": { "application/json": { "schema": { - "title": "discussion category changed event", + "title": "deploy_key deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "category_changed" + "deleted" ] }, - "changes": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "category": { - "type": "object", - "properties": { - "from": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - } - }, - "required": [ - "from" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" ] - } - }, - "required": [ - "category" - ] - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 ] }, - "answer_chosen_at": { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" ] }, - "answer_chosen_by": { - "title": "User", + "updated_at": { "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", + "string", "null" ], "format": "date-time", @@ -608314,6 +609873,55 @@ "node_id" ] }, + "key": { + "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#get-a-deploy-key) resource.", + "type": "object", + "properties": { + "added_by": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "last_used": { + "type": [ + "string", + "null" + ] + }, + "read_only": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "verified": { + "type": "boolean" + } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -610046,8 +611654,7 @@ }, "required": [ "action", - "changes", - "discussion", + "key", "repository", "sender" ] @@ -610063,7 +611670,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy-key", "supported-webhook-types": [ "repository", "organization", @@ -610072,13 +611679,13 @@ } } }, - "discussion-comment-created": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -610143,7 +611750,7 @@ "content": { "application/json": { "schema": { - "title": "discussion_comment created event", + "title": "deployment created event", "type": "object", "properties": { "action": { @@ -610152,107 +611759,15 @@ "created" ] }, - "comment": { + "deployment": { + "title": "Deployment", + "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployments).", "type": "object", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" - }, "created_at": { "type": "string" }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { - "type": [ - "integer", - "null" - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -610347,420 +611862,558 @@ "login", "id" ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body", - "reactions" - ] - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { + }, + "description": { "type": [ "string", "null" ] }, - "answer_chosen_at": { - "type": [ - "string", - "null" + "environment": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "original_environment": { + "type": "string" + }, + "payload": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } ] }, - "answer_chosen_by": { - "title": "User", + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ "object", "null" ], "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "workflow_job", + "pull_request_review_thread", + "merge_queue_entry", + "secret_scanning_alert_location", + "merge_group" + ] + } }, - "followers_url": { - "type": "string", + "external_url": { + "type": [ + "string", + "null" + ], "format": "uri" }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, "html_url": { "type": "string", "format": "uri" }, "id": { - "type": "integer" - }, - "login": { - "type": "string" + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] }, "name": { + "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } }, "slug": { + "description": "The slug name of the GitHub app", "type": "string" }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "id", - "repository_id", - "emoji", + "node_id", + "owner", "name", "description", + "external_url", + "html_url", "created_at", - "updated_at", - "slug", - "is_answerable" + "updated_at" ] }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { + "production_environment": { "type": "boolean" }, - "node_id": { + "ref": { "type": "string" }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { "type": "string" }, - "state": { + "statuses_url": { "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "format": "uri" }, - "timeline_url": { + "task": { "type": "string" }, - "title": { - "type": "string" + "transient_environment": { + "type": "boolean" }, "updated_at": { - "type": "string", - "format": "date-time" + "type": "string" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", + "url", "id", "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", "created_at", "updated_at", - "author_association", - "active_lock_reason", - "body" + "statuses_url", + "repository_url" ] }, "enterprise": { @@ -612606,217 +614259,71 @@ "type", "url" ] - } - }, - "required": [ - "action", - "comment", - "discussion", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion-comment", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-comment-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "discussion_comment deleted event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "deleted" - ] }, - "comment": { - "type": "object", + "workflow": { + "title": "Workflow", + "type": [ + "object", + "null" + ], "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "badge_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" + "format": "uri" }, "created_at": { - "type": "string" - }, - "discussion_id": { - "type": "integer" + "type": "string", + "format": "date-time" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "node_id": { + "name": { "type": "string" }, - "parent_id": { - "type": [ - "integer", - "null" - ] + "node_id": { + "type": "string" }, - "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" - ] + "path": { + "type": "string" }, - "repository_url": { + "state": { "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, - "user": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "badge_url", + "created_at", + "html_url", + "id", + "name", + "node_id", + "path", + "state", + "updated_at", + "url" + ] + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": [ + "object", + "null" + ], + "properties": { + "actor": { "title": "User", "type": [ "object", @@ -612911,41 +614418,637 @@ "login", "id" ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body", - "reactions" - ] - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { + }, + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { "type": [ "string", "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null ] }, - "answer_chosen_at": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "display_title": { + "type": "string" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { "type": [ - "string", "null" ] }, - "answer_chosen_by": { + "head_repository": { + "type": "object", + "properties": { + "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" + }, + "description": { + "type": [ + "null" + ] + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_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" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": [ + "null" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "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" + }, + "description": { + "type": [ + "null" + ] + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_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" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { "title": "User", "type": [ "object", @@ -613041,171 +615144,257 @@ "id" ] }, - "answer_html_url": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "deployment", + "workflow", + "workflow_run", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "deployment_status created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "check_run": { + "type": [ + "object", + "null" + ], + "properties": { + "completed_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", + "conclusion": { + "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "type": [ + "string", + "null" + ], "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + "skipped", + null ] }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] + "details_url": { + "type": "string", + "format": "uri" }, - "comments": { - "type": "integer" + "external_id": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { + "description": "The id of the check.", "type": "integer" }, - "locked": { - "type": "boolean" + "name": { + "description": "The name of the check run.", + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" + "started_at": { + "type": "string", + "format": "date-time" }, - "state": { + "status": { + "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`.", "type": "string", "enum": [ - "open", - "locked", - "converting", - "transferring" + "queued", + "in_progress", + "completed", + "waiting", + "pending" ] }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { + "url": { "type": "string", - "format": "date-time" + "format": "uri" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_sha", + "external_id", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at" + ] + }, + "deployment": { + "title": "Deployment", + "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployments).", + "type": "object", + "properties": { + "created_at": { + "type": "string" }, - "user": { + "creator": { "title": "User", "type": [ "object", @@ -613300,519 +615489,1693 @@ "login", "id" ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { + }, "description": { - "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" + "environment": { + "type": "string" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] + "original_environment": { + "type": "string" }, - "created_at": { - "type": [ - "string", - "null" + "payload": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { "type": [ + "null", "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "object" ] }, - "description": { + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_queue_entry", + "workflow_job", + "pull_request_review_thread", + "secret_scanning_alert_location", + "merge_group" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "key": { + "avatar_url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri" }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "deleted": { + "type": "boolean" }, - "url": { + "email": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, - "html_url": { + "url": { "type": "string", "format": "uri" } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "login", + "id" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" + "actions": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "email": { - "type": [ - "string", - "null" + "administration": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "login": { + "checks": { "type": "string", - "examples": [ - "octocat" + "enum": [ + "read", + "write" ] }, - "id": { - "type": "integer", - "examples": [ - 1 + "content_references": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "node_id": { + "contents": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "enum": [ + "read", + "write" ] }, - "avatar_url": { + "deployments": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "enum": [ + "read", + "write" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "discussions": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "url": { + "emails": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "enum": [ + "read", + "write" ] }, - "html_url": { + "environments": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "enum": [ + "read", + "write" ] }, - "followers_url": { + "issues": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "enum": [ + "read", + "write" ] }, - "following_url": { + "keys": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "enum": [ + "read", + "write" ] }, - "gists_url": { + "members": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "enum": [ + "read", + "write" ] }, - "starred_url": { + "metadata": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "read", + "write" ] }, - "subscriptions_url": { + "organization_administration": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "enum": [ + "read", + "write" ] }, - "organizations_url": { + "organization_hooks": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "read", + "write" ] }, - "repos_url": { + "organization_packages": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "enum": [ + "read", + "write" ] }, - "events_url": { + "organization_plan": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "enum": [ + "read", + "write" ] }, - "received_events_url": { + "organization_projects": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "enum": [ + "read", + "write" ] }, - "type": { + "organization_secrets": { "type": "string", - "examples": [ - "User" + "enum": [ + "read", + "write" ] }, - "site_admin": { - "type": "boolean" + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "starred_at": { + "organization_user_blocking": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" + } }, - "triage": { - "type": "boolean" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.", + "type": "string" + }, + "target_url": { + "description": "The optional link added to the status.", + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "state", + "creator", + "description", + "environment", + "target_url", + "created_at", + "updated_at", + "deployment_url", + "repository_url" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, "push": { "type": "boolean" @@ -615167,365 +618530,71 @@ "type", "url" ] - } - }, - "required": [ - "action", - "comment", - "discussion", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion-comment", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-comment-edited": { - "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "discussion_comment edited event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" - ] - }, - "changes": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "body" - ] }, - "comment": { - "type": "object", + "workflow": { + "title": "Workflow", + "type": [ + "object", + "null" + ], "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "badge_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" + "format": "uri" }, "created_at": { - "type": "string" - }, - "discussion_id": { - "type": "integer" + "type": "string", + "format": "date-time" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "node_id": { + "name": { "type": "string" }, - "parent_id": { - "type": [ - "integer", - "null" - ] + "node_id": { + "type": "string" }, - "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" - ] + "path": { + "type": "string" }, - "repository_url": { + "state": { "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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": [ + "badge_url", + "created_at", + "html_url", "id", + "name", "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", + "path", + "state", "updated_at", - "body", - "reactions" + "url" ] }, - "discussion": { - "title": "Discussion", - "type": "object", + "workflow_run": { + "title": "Deployment Workflow Run", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { + "actor": { "title": "User", "type": [ "object", @@ -615621,220 +618690,152 @@ "id" ] }, - "answer_html_url": { + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { "type": [ "string", "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "created_at": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "format": "date-time" }, - "body": { + "display_title": { + "type": "string" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { "type": [ - "string", "null" ] }, - "category": { + "head_repository": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "date-time" + "archive_url": { + "type": "string" }, - "description": { + "assignees_url": { "type": "string" }, - "emoji": { + "blobs_url": { "type": "string" }, - "id": { - "type": "integer" + "branches_url": { + "type": "string" }, - "is_answerable": { - "type": "boolean" + "collaborators_url": { + "type": "string" }, - "name": { + "comments_url": { "type": "string" }, - "node_id": { + "commits_url": { "type": "string" }, - "repository_id": { - "type": "integer" + "compare_url": { + "type": "string" }, - "slug": { + "contents_url": { "type": "string" }, - "updated_at": { + "contributors_url": { "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" }, - "-1": { - "type": "integer" + "deployments_url": { + "type": "string" }, - "confused": { - "type": "integer" + "description": { + "type": [ + "null" + ] }, - "eyes": { - "type": "integer" + "downloads_url": { + "type": "string" }, - "heart": { - "type": "integer" + "events_url": { + "type": "string" }, - "hooray": { - "type": "integer" + "fork": { + "type": "boolean" }, - "laugh": { - "type": "integer" + "forks_url": { + "type": "string" }, - "rocket": { - "type": "integer" + "full_name": { + "type": "string" }, - "total_count": { - "type": "integer" + "git_commits_url": { + "type": "string" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "git_refs_url": { + "type": "string" }, - "deleted": { - "type": "boolean" + "git_tags_url": { + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "hooks_url": { + "type": "string" }, - "events_url": { - "type": "string", - "format": "uri-template" + "html_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "format": "uri-template" + "issue_comment_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "issue_events_url": { + "type": "string" }, - "gravatar_id": { + "issues_url": { "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "keys_url": { + "type": "string" }, - "id": { - "type": "integer" + "labels_url": { + "type": "string" }, - "login": { + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { "type": "string" }, "name": { @@ -615843,147 +618844,1715 @@ "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" + "notifications_url": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } }, - "site_admin": { + "private": { "type": "boolean" }, - "starred_url": { - "type": "string", - "format": "uri-template" + "pulls_url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "releases_url": { + "type": "string" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "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" }, "url": { - "type": "string", - "format": "uri" + "type": "string" } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + } + }, + "head_sha": { + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], "format": "uri" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "type": "integer" }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" }, "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] + "node_id": { + "type": "string" }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "path": { + "type": "string" }, - "updated_at": { + "previous_attempt_url": { "type": [ - "string", "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "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" + }, + "description": { + "type": [ + "null" + ] + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_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" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "deployment_status", + "deployment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment-status", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-answered": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "discussion answered event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "answered" + ] + }, + "answer": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "null" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "discussion": { + "allOf": [ + { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": "string", + "format": "date-time" + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean", + "enum": [ + true + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by" + ] + } + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ @@ -617754,9 +622323,8 @@ }, "required": [ "action", - "changes", - "comment", "discussion", + "answer", "repository", "sender" ] @@ -617772,7 +622340,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion-comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -617781,11 +622349,11 @@ } } }, - "discussion-created": { + "discussion-category-changed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -617852,157 +622420,22 @@ "content": { "application/json": { "schema": { - "title": "discussion created event", + "title": "discussion category changed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "category_changed" ] }, - "discussion": { - "allOf": [ - { - "title": "Discussion", + "changes": { + "type": "object", + "properties": { + "category": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "category": { + "from": { "type": "object", "properties": { "created_at": { @@ -618048,434 +622481,410 @@ "slug", "is_answerable" ] + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "category" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "comments": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "created_at": { + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { "type": "string", - "format": "date-time" + "format": "uri-template" }, - "html_url": { + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "locked": { - "type": "boolean" + "login": { + "type": "string" }, - "node_id": { + "name": { "type": "string" }, - "number": { - "type": "integer" + "node_id": { + "type": "string" }, - "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" - ] + "organizations_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "format": "uri" }, - "timeline_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "title": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "updated_at": { + "subscriptions_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" + "login", + "id" ] }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "null" - ] - }, - "answer_chosen_by": { - "type": [ - "null" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "author_association": { - "type": "string" + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" }, - "body": { - "type": [ - "string", - "null" - ] + "description": { + "type": "string" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } + "emoji": { + "type": "string" }, - "comments": { + "id": { "type": "integer" }, - "created_at": { + "is_answerable": { + "type": "boolean" + }, + "name": { "type": "string" }, - "html_url": { + "node_id": { "type": "string" }, - "id": { + "repository_id": { "type": "integer" }, - "locked": { - "type": "boolean", - "enum": [ - false - ] + "slug": { + "type": "string" }, - "node_id": { + "updated_at": { "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "number": { + "-1": { "type": "integer" }, - "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" - } - } + "confused": { + "type": "integer" }, - "repository_url": { - "type": "string" + "eyes": { + "type": "integer" }, - "state": { + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { "type": "string", - "enum": [ - "open", - "converting", - "transferring" + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, - "timeline_url": { + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "title": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "updated_at": { + "name": { "type": "string" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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": [ - "state", - "locked", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by" + "login", + "id" ] } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" ] }, "enterprise": { @@ -620325,6 +624734,7 @@ }, "required": [ "action", + "changes", "discussion", "repository", "sender" @@ -620350,13 +624760,13 @@ } } }, - "discussion-deleted": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" }, "parameters": [ { @@ -620421,13 +624831,226 @@ "content": { "application/json": { "schema": { - "title": "discussion deleted event", + "title": "discussion_comment created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" + ] + }, + "comment": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "integer", + "null" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" ] }, "discussion": { @@ -620564,7 +625187,10 @@ ] }, "body": { - "type": "string" + "type": [ + "string", + "null" + ] }, "category": { "type": "object", @@ -622672,6 +627298,7 @@ }, "required": [ "action", + "comment", "discussion", "repository", "sender" @@ -622688,7 +627315,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion-comment", "supported-webhook-types": [ "repository", "organization", @@ -622697,13 +627324,13 @@ } } }, - "discussion-edited": { + "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" }, "parameters": [ { @@ -622768,59 +627395,245 @@ "content": { "application/json": { "schema": { - "title": "discussion edited event", + "title": "discussion_comment deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "deleted" ] }, - "changes": { + "comment": { "type": "object", "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, "body": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "integer", + "null" ] }, - "title": { + "reactions": { + "title": "Reactions", "type": "object", "properties": { - "from": { - "type": "string" + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "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": [ - "from" - ] - } - } - }, - "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] + "repository_url": { + "type": "string" }, - "answer_chosen_by": { + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { "title": "User", "type": [ "object", @@ -625046,6 +629859,7 @@ }, "required": [ "action", + "comment", "discussion", "repository", "sender" @@ -625062,7 +629876,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion-comment", "supported-webhook-types": [ "repository", "organization", @@ -625071,13 +629885,13 @@ } } }, - "discussion-labeled": { + "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment" }, "parameters": [ { @@ -625142,32 +629956,264 @@ "content": { "application/json": { "schema": { - "title": "discussion labeled event", + "title": "discussion_comment edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "labeled" + "edited" ] }, - "discussion": { - "title": "Discussion", + "changes": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" + "body": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "body" + ] + }, + "comment": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "answer_chosen_at": { + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { "type": [ - "string", + "integer", "null" ] }, - "answer_chosen_by": { + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { "title": "User", "type": [ "object", @@ -625664,49 +630710,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -627439,8 +632442,9 @@ }, "required": [ "action", + "changes", + "comment", "discussion", - "label", "repository", "sender" ] @@ -627456,7 +632460,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion-comment", "supported-webhook-types": [ "repository", "organization", @@ -627465,11 +632469,11 @@ } } }, - "discussion-locked": { + "discussion-created": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -627536,13 +632540,13 @@ "content": { "application/json": { "schema": { - "title": "discussion locked event", + "title": "discussion created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "locked" + "created" ] }, "discussion": { @@ -627681,302 +632685,308 @@ ] }, "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": "string" - }, - "answer_chosen_at": { "type": [ "string", "null" ] }, - "answer_chosen_by": { - "type": [ - "object", - "null" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "author_association": { - "type": "string" - }, - "body": { - "type": "string" - }, "category": { "type": "object", "properties": { "created_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "null" + ] + }, + "answer_chosen_by": { + "type": [ + "null" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" }, "description": { "type": "string" @@ -628022,7 +633032,7 @@ "locked": { "type": "boolean", "enum": [ - true + false ] }, "node_id": { @@ -628072,7 +633082,9 @@ "state": { "type": "string", "enum": [ - "locked" + "open", + "converting", + "transferring" ] }, "timeline_url": { @@ -628146,7 +633158,10 @@ }, "required": [ "state", - "locked" + "locked", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by" ] } ] @@ -630023,11 +635038,11 @@ } } }, - "discussion-pinned": { + "discussion-deleted": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -630094,13 +635109,13 @@ "content": { "application/json": { "schema": { - "title": "discussion pinned event", + "title": "discussion deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pinned" + "deleted" ] }, "discussion": { @@ -632370,11 +637385,11 @@ } } }, - "discussion-transferred": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -632441,1038 +637456,41 @@ "content": { "application/json": { "schema": { - "title": "discussion transferred event", + "title": "discussion edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "edited" ] }, "changes": { "type": "object", "properties": { - "new_discussion": { - "title": "Discussion", + "body": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { + "from": { "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" + "from" ] }, - "new_repository": { - "title": "Repository", - "description": "A git repository", + "title": { "type": "object", "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { + "from": { "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" + "from" ] } - }, - "required": [ - "new_discussion", - "new_repository" - ] + } }, "discussion": { "title": "Discussion", @@ -635716,7 +639734,6 @@ }, "required": [ "action", - "changes", "discussion", "repository", "sender" @@ -635742,11 +639759,11 @@ } } }, - "discussion-unanswered": { + "discussion-labeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -635813,783 +639830,222 @@ "content": { "application/json": { "schema": { - "title": "discussion unanswered event", + "title": "discussion labeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unanswered" + "labeled" ] }, "discussion": { - "allOf": [ - { - "title": "Discussion", - "type": "object", + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "deleted": { + "type": "boolean" }, - "answer_html_url": { + "email": { "type": [ "string", "null" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "events_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" + "format": "uri-template" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "comments": { - "type": "integer" + "following_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "gists_url": { "type": "string", - "format": "date-time" + "format": "uri-template" }, - "html_url": { + "gravatar_id": { "type": "string" }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "locked": { - "type": "boolean" + "login": { + "type": "string" }, - "node_id": { + "name": { "type": "string" }, - "number": { - "type": "integer" + "node_id": { + "type": "string" }, - "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" - ] + "organizations_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "format": "uri" }, - "timeline_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "title": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "updated_at": { + "subscriptions_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" + "login", + "id" ] }, - { + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "category": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "null" - ] - }, - "answer_chosen_by": { - "type": [ - "null" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "author_association": { - "type": "string" - }, - "body": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean", - "enum": [ - true - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { "type": "string" }, - "html_url": { + "emoji": { "type": "string" }, "id": { "type": "integer" }, - "locked": { + "is_answerable": { "type": "boolean" }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { + "name": { "type": "string" }, - "state": { + "node_id": { "type": "string" }, - "timeline_url": { - "type": "string" + "repository_id": { + "type": "integer" }, - "title": { + "slug": { "type": "string" }, "updated_at": { "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } } }, "required": [ - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by" - ] - } - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "old_answer": { - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" ] }, - "body": { - "type": "string" - }, - "child_comment_count": { + "comments": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, - "discussion_id": { - "type": "integer" - }, "html_url": { "type": "string" }, "id": { "type": "integer" }, + "locked": { + "type": "boolean" + }, "node_id": { "type": "string" }, - "parent_id": { - "type": [ - "null" - ] + "number": { + "type": "integer" }, "reactions": { "title": "Reactions", @@ -636643,6 +640099,21 @@ "repository_url": { "type": "string" }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time" @@ -636745,20 +640216,185 @@ } }, "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", "id", "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", + "number", + "title", "user", + "state", + "locked", + "comments", "created_at", "updated_at", + "author_association", + "active_lock_reason", "body" ] }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -638492,8 +642128,9 @@ "required": [ "action", "discussion", - "old_answer", - "repository" + "label", + "repository", + "sender" ] } } @@ -638516,11 +642153,11 @@ } } }, - "discussion-unlabeled": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -638587,408 +642224,619 @@ "content": { "application/json": { "schema": { - "title": "discussion unlabeled event", + "title": "discussion locked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "locked" ] }, "discussion": { - "title": "Discussion", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], + "allOf": [ + { + "title": "Discussion", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "answer_chosen_at": { + "type": [ + "string", + "null" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, - "following_url": { - "type": "string", - "format": "uri-template" + "answer_html_url": { + "type": [ + "string", + "null" + ] }, - "gists_url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri-template" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "gravatar_id": { + "body": { "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] }, - "id": { + "comments": { "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "answer_html_url": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { "created_at": { "type": "string", "format": "date-time" }, - "description": { - "type": "string" - }, - "emoji": { + "html_url": { "type": "string" }, "id": { "type": "integer" }, - "is_answerable": { + "locked": { "type": "boolean" }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, - "repository_id": { + "number": { "type": "integer" }, - "slug": { - "type": "string" + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "updated_at": { + "repository_url": { "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "locked": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "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" + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, - "rocket": { - "type": "integer" + "timeline_url": { + "type": "string" }, - "total_count": { - "type": "integer" + "title": { + "type": "string" }, - "url": { + "updated_at": { "type": "string", - "format": "uri" + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open", + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", "locked", - "converting", - "transferring" + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" ] }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], + { + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "active_lock_reason": { + "type": "string" }, - "deleted": { - "type": "boolean" + "answer_chosen_at": { + "type": [ + "string", + "null" + ] }, - "email": { + "answer_chosen_by": { + "type": [ + "object", + "null" + ] + }, + "answer_html_url": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "author_association": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "body": { + "type": "string" }, - "following_url": { - "type": "string", - "format": "uri-template" + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } }, - "gists_url": { - "type": "string", - "format": "uri-template" + "comments": { + "type": "integer" }, - "gravatar_id": { + "created_at": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "locked": { + "type": "boolean", + "enum": [ + true + ] }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "number": { + "type": "integer" }, - "starred_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "repository_url": { + "type": "string" }, - "type": { + "state": { "type": "string", "enum": [ - "Bot", - "User", - "Organization" + "locked" ] }, - "url": { - "type": "string", - "format": "uri" + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" + "state", + "locked" ] } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" ] }, "enterprise": { @@ -639106,49 +642954,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -640882,7 +644687,6 @@ "required": [ "action", "discussion", - "label", "repository", "sender" ] @@ -640907,11 +644711,11 @@ } } }, - "discussion-unlocked": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -640978,618 +644782,408 @@ "content": { "application/json": { "schema": { - "title": "discussion unlocked event", + "title": "discussion pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "pinned" ] }, "discussion": { - "allOf": [ - { - "title": "Discussion", - "type": "object", + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "answer_chosen_at": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" }, - "answer_chosen_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "deleted": { + "type": "boolean" }, - "answer_html_url": { + "email": { "type": [ "string", "null" ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "events_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" + "format": "uri-template" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "repository_id", - "emoji", - "name", - "description", - "created_at", - "updated_at", - "slug", - "is_answerable" - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "comments": { - "type": "integer" + "following_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "gists_url": { "type": "string", - "format": "date-time" + "format": "uri-template" }, - "html_url": { + "gravatar_id": { "type": "string" }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "locked": { - "type": "boolean" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "received_events_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "state": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string", "enum": [ - "open", - "locked", - "converting", - "transferring" + "Bot", + "User", + "Organization" ] }, - "timeline_url": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { "type": "string" }, - "title": { + "emoji": { "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "id": { + "type": "integer" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" } }, "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", "id", - "node_id", - "number", - "title", - "user", - "state", - "locked", - "comments", + "repository_id", + "emoji", + "name", + "description", "created_at", "updated_at", - "author_association", - "active_lock_reason", - "body" + "slug", + "is_answerable" ] }, - { + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "null" - ] + "+1": { + "type": "integer" }, - "answer_chosen_at": { - "type": [ - "null" - ] + "-1": { + "type": "integer" }, - "answer_chosen_by": { - "type": [ - "null" - ] + "confused": { + "type": "integer" }, - "answer_html_url": { + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ + "string", "null" ] }, - "author_association": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "body": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "category": { - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "emoji": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_answerable": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "repository_id": { - "type": "integer" - }, - "slug": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } + "following_url": { + "type": "string", + "format": "uri-template" }, - "comments": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "created_at": { + "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "locked": { - "type": "boolean", - "enum": [ - false - ] + "login": { + "type": "string" }, - "node_id": { + "name": { "type": "string" }, - "number": { - "type": "integer" + "node_id": { + "type": "string" }, - "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" - } - } + "organizations_url": { + "type": "string", + "format": "uri" }, - "repository_url": { - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { + "repos_url": { "type": "string", - "enum": [ - "open" - ] + "format": "uri" }, - "timeline_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "title": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "updated_at": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "state", - "locked" + "login", + "id" ] } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" ] }, "enterprise": { @@ -643464,11 +647058,11 @@ } } }, - "discussion-unpinned": { + "discussion-transferred": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, @@ -643535,13 +647129,1037 @@ "content": { "application/json": { "schema": { - "title": "discussion unpinned event", + "title": "discussion transferred event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpinned" + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "new_discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + "new_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" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "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" + ] + } + }, + "required": [ + "new_discussion", + "new_repository" ] }, "discussion": { @@ -645786,6 +650404,7 @@ }, "required": [ "action", + "changes", "discussion", "repository", "sender" @@ -645811,12 +650430,13 @@ } } }, - "fork": { + "discussion-unanswered": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" 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.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -645881,406 +650501,294 @@ "content": { "application/json": { "schema": { - "title": "fork event", - "description": "A user forks a repository.", + "title": "discussion unanswered event", "type": "object", "properties": { - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "action": { + "type": "string", + "enum": [ + "unanswered" ] }, - "forkee": { - "description": "The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-a-repository) resource.", + "discussion": { "allOf": [ { - "title": "Repository", - "description": "A git repository", + "title": "Discussion", "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" + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "contributors_url": { - "type": "string", - "format": "uri" + "answer_chosen_at": { + "type": [ + "string", + "null" + ] }, - "created_at": { - "oneOf": [ - { + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - { + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "format": "date-time" + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, - "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": { + "answer_html_url": { "type": [ "string", "null" ] }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "full_name": { + "body": { "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 - }, - "homepage": { - "type": [ - "string", - "null" + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" ] }, - "hooks_url": { + "comments": { + "type": "integer" + }, + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { - "description": "Unique identifier of the repository", "type": "integer" }, - "is_template": { + "locked": { "type": "boolean" }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] + "node_id": { + "type": "string" }, - "languages_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], + "reactions": { + "title": "Reactions", + "type": "object", "properties": { - "key": { - "type": "string" + "+1": { + "type": "integer" }, - "name": { - "type": "string" + "-1": { + "type": "integer" }, - "node_id": { - "type": "string" + "confused": { + "type": "integer" }, - "spdx_id": { - "type": "string" + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" }, "url": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "uri" } }, "required": [ - "key", - "name", - "spdx_id", "url", - "node_id" + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "master_branch": { + "repository_url": { "type": "string" }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { + "state": { "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, - "name": { - "description": "The name of the repository.", + "timeline_url": { "type": "string" }, - "node_id": { + "title": { "type": "string" }, - "notifications_url": { + "updated_at": { "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" + "format": "date-time" }, - "owner": { + "user": { "title": "User", "type": [ "object", @@ -646375,341 +650883,106 @@ "login", "id" ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "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": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", "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", + "number", + "title", + "user", + "state", + "locked", + "comments", "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", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" + "author_association", + "active_lock_reason", + "body" ] }, { "type": "object", "properties": { - "allow_forking": { - "type": "boolean" - }, - "archive_url": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "clone_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" - }, - "created_at": { - "type": "string" + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "default_branch": { - "type": "string" + "answer_chosen_at": { + "type": [ + "null" + ] }, - "deployments_url": { - "type": "string" + "answer_chosen_by": { + "type": [ + "null" + ] }, - "description": { + "answer_html_url": { "type": [ "string", "null" ] }, - "disabled": { - "type": "boolean" - }, - "downloads_url": { + "author_association": { "type": "string" }, - "events_url": { + "body": { "type": "string" }, - "fork": { - "type": "boolean", - "enum": [ - true + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean", + "enum": [ + true + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "is_answerable" ] }, - "forks": { - "type": "integer" - }, - "forks_count": { + "comments": { "type": "integer" }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { + "created_at": { "type": "string" }, "html_url": { @@ -646718,65 +650991,66 @@ "id": { "type": "integer" }, - "is_template": { + "locked": { "type": "boolean" }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { + "node_id": { "type": "string" }, - "language": { - "type": [ - "null" - ] - }, - "languages_url": { - "type": "string" + "number": { + "type": "integer" }, - "license": { - "type": [ - "object", - "null" - ] + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } }, - "merges_url": { + "repository_url": { "type": "string" }, - "milestones_url": { + "state": { "type": "string" }, - "mirror_url": { - "type": [ - "null" - ] - }, - "name": { + "timeline_url": { "type": "string" }, - "node_id": { + "title": { "type": "string" }, - "notifications_url": { + "updated_at": { "type": "string" }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "owner": { + "user": { "type": "object", "properties": { "avatar_url": { @@ -646834,105 +651108,343 @@ "type": "string" } } + } + }, + "required": [ + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by" + ] + } + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "old_answer": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": [ + "null" + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "private": { - "type": "boolean" + "-1": { + "type": "integer" }, - "public": { - "type": "boolean" + "confused": { + "type": "integer" }, - "pulls_url": { - "type": "string" + "eyes": { + "type": "integer" }, - "pushed_at": { - "type": "string" + "heart": { + "type": "integer" }, - "releases_url": { - "type": "string" + "hooray": { + "type": "integer" }, - "size": { + "laugh": { "type": "integer" }, - "ssh_url": { - "type": "string" + "rocket": { + "type": "integer" }, - "stargazers_count": { + "total_count": { "type": "integer" }, - "stargazers_url": { - "type": "string" + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "statuses_url": { - "type": "string" + "deleted": { + "type": "boolean" }, - "subscribers_url": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "subscription_url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "svn_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "tags_url": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "teams_url": { + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "topics": { - "type": "array", - "items": { - "type": [ - "null" - ] - } + "html_url": { + "type": "string", + "format": "uri" }, - "trees_url": { - "type": "string" + "id": { + "type": "integer" }, - "updated_at": { + "login": { "type": "string" }, - "url": { + "name": { "type": "string" }, - "visibility": { + "node_id": { "type": "string" }, - "watchers": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "watchers_count": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - } - } - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + }, + "required": [ + "login", + "id" ] } }, "required": [ "id", - "node_id" + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" ] }, "organization": { @@ -648666,9 +653178,10 @@ } }, "required": [ - "forkee", - "repository", - "sender" + "action", + "discussion", + "old_answer", + "repository" ] } } @@ -648682,9 +653195,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "discussion", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -648692,13 +653204,13 @@ } } }, - "github-app-authorization-revoked": { + "discussion-unlabeled": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about user-to-server requests, which require GitHub App authorization, see \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -648763,13 +653275,408 @@ "content": { "application/json": { "schema": { - "title": "github_app_authorization revoked event", + "title": "discussion unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "revoked" + "unlabeled" + ] + }, + "discussion": { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" ] }, "enterprise": { @@ -648887,6 +653794,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -650619,6 +655569,9 @@ }, "required": [ "action", + "discussion", + "label", + "repository", "sender" ] } @@ -650633,19 +655586,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github-app-authorization", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "gollum": { + "discussion-unlocked": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -650710,9 +655666,620 @@ "content": { "application/json": { "schema": { - "title": "gollum event", + "title": "discussion unlocked event", "type": "object", "properties": { + "action": { + "type": "string", + "enum": [ + "unlocked" + ] + }, + "discussion": { + "allOf": [ + { + "title": "Discussion", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "string", + "null" + ] + }, + "answer_chosen_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "null" + ] + }, + "answer_chosen_at": { + "type": [ + "null" + ] + }, + "answer_chosen_by": { + "type": [ + "null" + ] + }, + "answer_html_url": { + "type": [ + "null" + ] + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean", + "enum": [ + false + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "locked" + ] + } + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -650927,54 +656494,6 @@ "description" ] }, - "pages": { - "description": "The pages that were updated.", - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "description": "The action that was performed on the page. Can be `created` or `edited`.", - "type": "string", - "enum": [ - "created", - "edited" - ] - }, - "html_url": { - "description": "Points to the HTML wiki page.", - "type": "string", - "format": "uri" - }, - "page_name": { - "description": "The name of the page.", - "type": "string" - }, - "sha": { - "description": "The latest commit SHA of the page.", - "type": "string" - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "title": { - "description": "The current page title.", - "type": "string" - } - }, - "required": [ - "page_name", - "title", - "summary", - "action", - "sha", - "html_url" - ] - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -652607,7 +658126,8 @@ } }, "required": [ - "pages", + "action", + "discussion", "repository", "sender" ] @@ -652623,7 +658143,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -652632,13 +658152,13 @@ } } }, - "installation-created": { + "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -652703,946 +658223,523 @@ "content": { "application/json": { "schema": { - "title": "installation created event", + "title": "discussion unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "unpinned" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "discussion": { + "title": "Discussion", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", + "active_lock_reason": { "type": [ "string", "null" ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", + "answer_chosen_at": { "type": [ "string", "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" ] }, - "created_at": { + "answer_chosen_by": { + "title": "User", "type": [ - "string", + "object", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, - "updated_at": { + "answer_html_url": { "type": [ "string", "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" ] }, - "avatar_url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" ] }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] + "comments": { + "type": "integer" }, - "repositories_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] + "format": "date-time" }, "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] + "type": "string" }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", + "id": { "type": "integer" }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] + "locked": { + "type": "boolean" }, - "permissions": { - "title": "App Permissions", + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] + "+1": { + "type": "integer" }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] + "-1": { + "type": "integer" }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] + "confused": { + "type": "integer" }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] + "eyes": { + "type": "integer" }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] + "heart": { + "type": "integer" }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] + "hooray": { + "type": "integer" }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "laugh": { + "type": "integer" }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] + "rocket": { + "type": "integer" }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] + "total_count": { + "type": "integer" }, - "repository_announcement_banners": { + "url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] + "deleted": { + "type": "boolean" }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "secrets": { + "events_url": { "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "security_events": { + "followers_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "single_file": { + "following_url": { "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "statuses": { + "gists_url": { "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] + "gravatar_id": { + "type": "string" }, - "workflows": { + "html_url": { "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] + "format": "uri" }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] + "login": { + "type": "string" }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] + "name": { + "type": "string" }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "organization_hooks": { + "organizations_url": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_plan": { + "received_events_url": { "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] + "format": "uri" }, - "organization_projects": { + "repos_url": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] + "format": "uri" }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "organization_secrets": { + "starred_url": { "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_self_hosted_runners": { + "subscriptions_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_user_blocking": { + "type": { "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ - "read", - "write" + "Bot", + "User", + "Organization" ] }, - "team_discussions": { + "url": { "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] + "format": "uri" } }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "single_file_name": { + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "examples": [ - "config.yaml" - ] + "format": "uri" }, - "has_multiple_single_files": { - "type": "boolean", + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", "examples": [ - true + 42 ] }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, + "node_id": { + "type": "string", "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "app_slug": { + "name": { + "description": "The name of the enterprise.", "type": "string", "examples": [ - "github-actions" + "Octo Business" ] }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" ] }, - "suspended_at": { + "created_at": { "type": [ "string", "null" ], - "format": "date-time" + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "contact_email": { + "updated_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", + "node_id", + "name", + "slug", "html_url", - "repositories_url", - "events", - "account", - "permissions", "created_at", "updated_at", - "suspended_by", - "suspended_at" + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" ] }, "organization": { @@ -653744,40 +658841,6 @@ "description" ] }, - "repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -655247,102 +660310,6 @@ "updated_at" ] }, - "requester": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -655507,7 +660474,8 @@ }, "required": [ "action", - "installation", + "discussion", + "repository", "sender" ] } @@ -655522,20 +660490,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-deleted": { + "fork": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" 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.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -655600,15 +660569,10 @@ "content": { "application/json": { "schema": { - "title": "installation deleted event", + "title": "fork event", + "description": "A user forks a repository.", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "deleted" - ] - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -655699,30 +660663,324 @@ "avatar_url" ] }, - "installation": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "forkee": { + "description": "The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-a-repository) resource.", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], "properties": { + "key": { + "type": "string" + }, "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { "type": [ "string", "null" - ] + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -655730,816 +660988,639 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "id": { + "type": "integer" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "login": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "name": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "node_id": { + "type": "string" }, - "subscriptions_url": { + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "received_events_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "format": "uri" }, "repos_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "format": "uri" }, - "events_url": { + "site_admin": { + "type": "boolean" + }, + "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri-template" }, - "received_events_url": { + "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "uri" }, "type": { "type": "string", - "examples": [ - "User" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "permissions": { "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "admin": { + "type": "boolean" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] + "maintain": { + "type": "boolean" }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "pull": { + "type": "boolean" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "push": { + "type": "boolean" }, - "avatar_url": { - "type": "string", - "format": "uri" + "triage": { + "type": "boolean" } }, "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" + "pull", + "push", + "admin" ] }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] + "public": { + "type": "boolean" }, - "contents": { + "pulls_url": { "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" ] }, - "environments": { + "releases_url": { "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" + "role_name": { + "type": [ + "string", + "null" ] }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] + "size": { + "type": "integer" }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "ssh_url": { + "type": "string" }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] + "stargazers": { + "type": "integer" }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] + "stargazers_count": { + "type": "integer" }, - "repository_announcement_banners": { + "stargazers_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "repository_hooks": { + "statuses_url": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "repository_projects": { + "subscribers_url": { "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] + "format": "uri" }, - "secret_scanning_alerts": { + "subscription_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "secrets": { + "svn_url": { "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_events": { + "tags_url": { "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "single_file": { + "teams_url": { "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] + "topics": { + "type": "array", + "items": { + "type": "string" + } }, - "vulnerability_alerts": { + "trees_url": { "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "workflows": { + "updated_at": { "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] + "format": "date-time" }, - "members": { + "url": { "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_administration": { + "visibility": { "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ - "read", - "write" + "public", + "private", + "internal" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] + "watchers": { + "type": "integer" }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] + "watchers_count": { + "type": "integer" }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] + "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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + { + "type": "object", + "properties": { + "allow_forking": { + "type": "boolean" }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] + "archive_url": { + "type": "string" }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" + "archived": { + "type": "boolean" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "clone_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" + }, + "created_at": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" ] }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "disabled": { + "type": "boolean" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean", "enum": [ - "read", - "write" + true ] }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "has_downloads": { + "type": "boolean" + }, + "has_issues": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "homepage": { + "type": [ + "string", + "null" ] }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "language": { + "type": [ + "null" ] }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" + "languages_url": { + "type": "string" + }, + "license": { + "type": [ + "object", + "null" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "null" ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "owner": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "events_url": { + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "type": "string" }, "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "type": "string" }, "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "gravatar_id": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "html_url": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "id": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "login": { + "type": "string" }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" }, "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "type": "string" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "repos_url": { + "type": "string" }, "site_admin": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } + }, + "private": { + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "topics": { + "type": "array", + "items": { + "type": [ + "null" + ] + } + }, + "trees_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" } + } + } + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 ] }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "required": [ "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" + "node_id" ] }, "organization": { @@ -656641,40 +661722,6 @@ "description" ] }, - "repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -658144,11 +663191,6 @@ "updated_at" ] }, - "requester": { - "type": [ - "null" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -658312,8 +663354,8 @@ } }, "required": [ - "action", - "installation", + "forkee", + "repository", "sender" ] } @@ -658328,20 +663370,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "fork", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "installation-new-permissions-accepted": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about user-to-server requests, which require GitHub App authorization, see \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization" }, "parameters": [ { @@ -658406,13 +663451,13 @@ "content": { "application/json": { "schema": { - "title": "installation new_permissions_accepted event", + "title": "github_app_authorization revoked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "new_permissions_accepted" + "revoked" ] }, "enterprise": { @@ -658506,8 +663551,8 @@ ] }, "installation": { - "title": "Installation", - "description": "Installation", + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", "type": "object", "properties": { "id": { @@ -658517,835 +663562,17 @@ 1 ] }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "required": [ "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" + "node_id" ] }, "organization": { @@ -659447,40 +663674,6 @@ "description" ] }, - "repositories": { - "description": "An array of repository objects that the installation can access.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -660950,11 +665143,6 @@ "updated_at" ] }, - "requester": { - "type": [ - "null" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -661119,7 +665307,6 @@ }, "required": [ "action", - "installation", "sender" ] } @@ -661134,20 +665321,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "github-app-authorization", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-added": { + "gollum": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -661212,15 +665398,9 @@ "content": { "application/json": { "schema": { - "title": "installation_repositories added event", + "title": "gollum event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "added" - ] - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -661312,8 +665492,8 @@ ] }, "installation": { - "title": "Installation", - "description": "Installation", + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", "type": "object", "properties": { "id": { @@ -661323,835 +665503,17 @@ 1 ] }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", - "enum": [ - "read", - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "required": [ "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" + "node_id" ] }, "organization": { @@ -662253,67 +665615,54 @@ "description" ] }, - "repositories_added": { - "description": "An array of repository objects, which were added to the installation.", + "pages": { + "description": "The pages that were updated.", "type": "array", "items": { "type": "object", "properties": { - "full_name": { - "type": "string" + "action": { + "description": "The action that was performed on the page. Can be `created` or `edited`.", + "type": "string", + "enum": [ + "created", + "edited" + ] }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" + "html_url": { + "description": "Points to the HTML wiki page.", + "type": "string", + "format": "uri" }, - "name": { - "description": "The name of the repository.", + "page_name": { + "description": "The name of the page.", "type": "string" }, - "node_id": { + "sha": { + "description": "The latest commit SHA of the page.", "type": "string" }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" + "summary": { + "type": [ + "string", + "null" + ] + }, + "title": { + "description": "The current page title.", + "type": "string" } }, "required": [ - "id", - "node_id", - "name", - "full_name", - "private" + "page_name", + "title", + "summary", + "action", + "sha", + "html_url" ] } }, - "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - } - } - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -663783,110 +667132,6 @@ "updated_at" ] }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "requester": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -664050,12 +667295,8 @@ } }, "required": [ - "action", - "installation", - "repository_selection", - "repositories_added", - "repositories_removed", - "requester", + "pages", + "repository", "sender" ] } @@ -664070,20 +667311,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation-repositories", + "subcategory": "gollum", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-removed": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -664148,13 +667391,13 @@ "content": { "application/json": { "schema": { - "title": "installation_repositories removed event", + "title": "installation created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "removed" + "created" ] }, "enterprise": { @@ -665189,42 +668432,8 @@ "description" ] }, - "repositories_added": { - "description": "An array of repository objects, which were added to the installation.", - "type": "array", - "items": { - "type": "object", - "properties": { - "full_name": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "name", - "full_name", - "private" - ] - } - }, - "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "repositories": { + "description": "An array of repository objects that the installation can access.", "type": "array", "items": { "type": "object", @@ -666726,14 +669935,6 @@ "updated_at" ] }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, "requester": { "title": "User", "type": [ @@ -666995,10 +670196,6 @@ "required": [ "action", "installation", - "repository_selection", - "repositories_added", - "repositories_removed", - "requester", "sender" ] } @@ -667013,18 +670210,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation-repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-suspend": { + "installation-deleted": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, @@ -667091,13 +670288,13 @@ "content": { "application/json": { "schema": { - "title": "installation suspend event", + "title": "installation deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "suspend" + "deleted" ] }, "enterprise": { @@ -669826,13 +673023,13 @@ } } }, - "installation-target-renamed": { + "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-target" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -669897,157 +673094,14 @@ "content": { "application/json": { "schema": { + "title": "installation new_permissions_accepted event", "type": "object", "properties": { - "account": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "description": { - "type": [ - "null" - ] - }, - "events_url": { - "type": "string" - }, - "followers": { - "type": "integer" - }, - "followers_url": { - "type": "string" - }, - "following": { - "type": "integer" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "has_organization_projects": { - "type": "boolean" - }, - "has_repository_projects": { - "type": "boolean" - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_verified": { - "type": "boolean" - }, - "issues_url": { - "type": "string" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "public_gists": { - "type": "integer" - }, - "public_members_url": { - "type": "string" - }, - "public_repos": { - "type": "integer" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "slug": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "website_url": { - "type": [ - "null" - ] - } - }, - "required": [ - "id", - "node_id", - "avatar_url", - "html_url" - ] - }, "action": { - "type": "string" - }, - "changes": { - "type": "object", - "properties": { - "login": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "slug": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - } + "type": "string", + "enum": [ + "new_permissions_accepted" + ] }, "enterprise": { "title": "Enterprise", @@ -670140,8 +673194,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -670151,17 +673205,835 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ "id", - "node_id" + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" ] }, "organization": { @@ -670263,6 +674135,40 @@ "description" ] }, + "repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -671732,6 +675638,11 @@ "updated_at" ] }, + "requester": { + "type": [ + "null" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -671892,17 +675803,12 @@ "type", "url" ] - }, - "target_type": { - "type": "string" } }, "required": [ "action", - "target_type", - "account", - "changes", - "installation" + "installation", + "sender" ] } } @@ -671916,20 +675822,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation-target", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-unsuspend": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" }, "parameters": [ { @@ -671994,13 +675900,13 @@ "content": { "application/json": { "schema": { - "title": "installation unsuspend event", + "title": "installation_repositories added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unsuspend" + "added" ] }, "enterprise": { @@ -673035,8 +676941,8 @@ "description" ] }, - "repositories": { - "description": "An array of repository objects that the installation can access.", + "repositories_added": { + "description": "An array of repository objects, which were added to the installation.", "type": "array", "items": { "type": "object", @@ -673069,6 +676975,33 @@ ] } }, + "repositories_removed": { + "description": "An array of repository objects, which were removed from the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + } + } + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -674538,9 +678471,108 @@ "updated_at" ] }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, "requester": { + "title": "User", "type": [ + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, "sender": { @@ -674708,6 +678740,10 @@ "required": [ "action", "installation", + "repository_selection", + "repositories_added", + "repositories_removed", + "requester", "sender" ] } @@ -674722,20 +678758,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation-repositories", "supported-webhook-types": [ "app" ] } } }, - "issue-comment-created": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories" }, "parameters": [ { @@ -674800,558 +678836,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment created event", + "title": "installation_repositories removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" - ] - }, - "comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments) itself.", - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "url", - "html_url", - "issue_url", - "id", - "node_id", - "user", - "created_at", - "updated_at", - "author_association", - "performed_via_github_app", - "body", - "reactions" + "removed" ] }, "enterprise": { @@ -675445,8 +678936,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -675456,1794 +678947,8 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) the comment belongs to.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - }, - "required": [ - "labels", - "state", - "locked", - "assignee" - ] - } - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { + "account": { "anyOf": [ - { - "type": "null" - }, { "title": "Simple User", "description": "A GitHub user.", @@ -677404,107 +679109,1201 @@ "type", "url" ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } + ], + "type": [ + "null", + "object" ] }, - "forks": { + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", "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" + "target_type": { + "type": "string", + "examples": [ + "Organization" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user-to-server access token.", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" ] }, - "login": { + "administration": { "type": "string", - "examples": [ - "octocat" + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" ] }, - "id": { - "type": "integer", - "examples": [ - 1 + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" ] }, - "node_id": { + "contents": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" ] }, - "avatar_url": { + "deployments": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" ] }, - "url": { + "issues": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" ] }, - "html_url": { + "metadata": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" ] }, - "followers_url": { + "packages": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repositories_added": { + "description": "An array of repository objects, which were added to the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "repositories_removed": { + "description": "An array of repository objects, which were removed from the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, "following_url": { @@ -678615,6 +681414,110 @@ "updated_at" ] }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "requester": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -678779,9 +681682,11 @@ }, "required": [ "action", - "issue", - "comment", - "repository", + "installation", + "repository_selection", + "repositories_added", + "repositories_removed", + "requester", "sender" ] } @@ -678796,22 +681701,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-comment", + "subcategory": "installation-repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-deleted": { + "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -678876,559 +681779,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "installation suspend event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" - ] - }, - "comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments) itself.", - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "required": [ - "url", - "html_url", - "issue_url", - "id", - "node_id", - "user", - "created_at", - "updated_at", - "author_association", - "performed_via_github_app", - "body", - "reactions" + "suspend" ] }, "enterprise": { @@ -679522,8 +681879,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -679533,53 +681890,18 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) the comment belongs to.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -679587,1085 +681909,628 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "id": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "login": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "name": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, "site_admin": { "type": "boolean" }, - "starred_url": { + "starred_at": { "type": "string", - "format": "uri-template" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "subscriptions_url": { + "html_url": { "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], "format": "uri" }, - "type": { + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "url": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" } }, "required": [ - "login", - "id" + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "checks": { "type": "string", + "description": "The level of permission to grant the access token for checks on code.", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "read", + "write" ] }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] }, - "comments": { - "type": "integer" + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] }, - "comments_url": { + "issues": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] }, - "created_at": { + "metadata": { "type": "string", - "format": "date-time" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] }, - "draft": { - "type": "boolean" + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] }, - "events_url": { + "pages": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] }, - "html_url": { + "pull_requests": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] }, - "id": { - "type": "integer" + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] }, - "labels_url": { + "repository_projects": { "type": "string", - "format": "uri-template" + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] }, - "locked": { - "type": "boolean" + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" ] }, - "node_id": { - "type": "string" + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] }, - "number": { - "type": "integer" + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" ] }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] }, - "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" + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" ] }, - "repository_url": { + "members": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", + "organization_administration": { "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ - "open", - "closed" + "read", + "write" ] }, - "state_reason": { - "type": [ - "string", - "null" + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" ] }, - "timeline_url": { + "organization_announcement_banners": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] }, - "title": { - "description": "Title of the issue", - "type": "string" + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] }, - "updated_at": { + "organization_plan": { "type": "string", - "format": "date-time" + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] }, - "url": { - "description": "URL for the issue", + "organization_projects": { "type": "string", - "format": "uri" + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -680673,451 +682538,187 @@ "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { + "login": { "type": "string", - "format": "uri" + "examples": [ + "octocat" + ] }, "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "MDQ6VXNlcjE=" ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { "avatar_url": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "email": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, "following_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, "gists_url": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "organizations_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "received_events_url": { + "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "starred_url": { + "events_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "examples": [ + "User" ] }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } } - }, - "required": [ - "labels", - "state", - "locked", - "assignee" + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" ] }, "organization": { @@ -681219,6 +682820,40 @@ "description" ] }, + "repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -682688,6 +684323,11 @@ "updated_at" ] }, + "requester": { + "type": [ + "null" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -682852,9 +684492,7 @@ }, "required": [ "action", - "issue", - "comment", - "repository", + "installation", "sender" ] } @@ -682869,22 +684507,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-edited": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-target" }, "parameters": [ { @@ -682949,24 +684585,149 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "edited" + "account": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": [ + "null" + ] + }, + "events_url": { + "type": "string" + }, + "followers": { + "type": "integer" + }, + "followers_url": { + "type": "string" + }, + "following": { + "type": "integer" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_verified": { + "type": "boolean" + }, + "issues_url": { + "type": "string" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "public_gists": { + "type": "integer" + }, + "public_members_url": { + "type": "string" + }, + "public_repos": { + "type": "integer" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "slug": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "website_url": { + "type": [ + "null" + ] + } + }, + "required": [ + "id", + "node_id", + "avatar_url", + "html_url" ] }, + "action": { + "type": "string" + }, "changes": { - "description": "The changes to the comment.", "type": "object", "properties": { - "body": { + "login": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "slug": { "type": "object", "properties": { "from": { - "description": "The previous version of the body.", "type": "string" } }, @@ -682976,550 +684737,1958 @@ } } }, - "comment": { - "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments) itself.", + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" ] }, - "body": { - "description": "Contents of the issue comment", - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "created_at": { + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "format": "date-time" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "html_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri" + "examples": [ + "Octo Business" + ] }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer" + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] }, - "issue_url": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", + "key": { + "type": "string", "examples": [ - 37 + "mit" ] }, - "slug": { - "description": "The slug name of the GitHub app", + "name": { "type": "string", "examples": [ - "probot-owners" + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" ] }, "node_id": { "type": "string", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "MDc6TGljZW5zZW1pdA==" ] }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "name": { - "description": "The name of the GitHub app", + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "Probot Owners" + "octocat" ] }, - "description": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "The description of the app." + "41d064eb2195891e12d0413f63227ea7" ] }, - "external_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://github.com/octocat" ] }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/followers" ] }, - "updated_at": { + "following_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, + "starred_url": { + "type": "string", "examples": [ - "label", - "deployment" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", + "subscriptions_url": { + "type": "string", + "format": "uri", "examples": [ - 5 + "https://api.github.com/users/octocat/subscriptions" ] }, - "client_id": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat/orgs" ] }, - "client_secret": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + "https://api.github.com/users/octocat/repos" ] }, - "webhook_secret": { - "type": [ - "string", - "null" - ], + "events_url": { + "type": "string", "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "pem": { + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { "type": "string", "examples": [ - "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "reactions": { - "title": "Reactions", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "+1": { - "type": "integer" + "admin": { + "type": "boolean" }, - "-1": { - "type": "integer" + "pull": { + "type": "boolean" }, - "confused": { - "type": "integer" + "triage": { + "type": "boolean" }, - "eyes": { - "type": "integer" + "push": { + "type": "boolean" }, - "heart": { - "type": "integer" + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "hooray": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] }, - "laugh": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "rocket": { - "type": "integer" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "total_count": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "updated_at": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" }, "url": { - "description": "URL for the issue comment", "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "user": { - "title": "User", + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { "type": [ "object", "null" ], "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer" }, - "deleted": { + "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" }, - "email": { - "type": [ - "string", - "null" - ] + "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", - "format": "uri-template" + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "forks_url": { + "type": "string" }, - "following_url": { - "type": "string", - "format": "uri-template" + "git_commits_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "git_refs_url": { + "type": "string" }, - "gravatar_id": { + "git_tags_url": { "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "git_url": { + "type": "string" }, - "id": { + "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" }, - "login": { + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { "type": "string" }, - "name": { + "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" }, - "node_id": { + "pushed_at": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" + "created_at": { + "type": "string" }, - "received_events_url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } }, - "site_admin": { + "allow_rebase_merge": { "type": "boolean" }, - "starred_url": { + "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", - "format": "uri-template" + "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)." }, - "subscriptions_url": { + "squash_merge_commit_message": { "type": "string", - "format": "uri" + "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." }, - "type": { + "merge_commit_title": { "type": "string", "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] + "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)." }, - "url": { + "merge_commit_message": { "type": "string", - "format": "uri" + "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": [ - "login", - "id" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "url", + "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", - "issue_url", "id", "node_id", - "user", + "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", - "author_association", - "performed_via_github_app", - "body", - "reactions" + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "target_type": { + "type": "string" + } + }, + "required": [ + "action", + "target_type", + "account", + "changes", + "installation" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation-target", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-unsuspend": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/reference/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "installation unsuspend event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unsuspend" ] }, "enterprise": { @@ -683613,8 +686782,8 @@ ] }, "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { "id": { @@ -683624,1793 +686793,8 @@ 1 ] }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) the comment belongs to.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - }, - "required": [ - "labels", - "state", - "locked", - "assignee" - ] - } - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { + "account": { "anyOf": [ - { - "type": "null" - }, { "title": "Simple User", "description": "A GitHub user.", @@ -685571,122 +686955,1182 @@ "type", "url" ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } + ], + "type": [ + "null", + "object" ] }, - "forks": { + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", "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" + "target_type": { + "type": "string", + "examples": [ + "Organization" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user-to-server access token.", "properties": { - "name": { - "type": [ - "string", - "null" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" ] }, - "email": { - "type": [ - "string", - "null" + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" ] }, - "login": { + "checks": { "type": "string", - "examples": [ - "octocat" + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" ] }, - "id": { - "type": "integer", - "examples": [ - 1 + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" ] }, - "node_id": { + "deployments": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" ] }, - "avatar_url": { + "environments": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" ] }, - "url": { + "metadata": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" ] }, - "html_url": { + "packages": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" ] }, - "followers_url": { + "pages": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" ] }, - "following_url": { + "pull_requests": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" ] }, - "gists_url": { + "repository_announcement_banners": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" ] }, - "starred_url": { + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" @@ -686782,6 +689226,11 @@ "updated_at" ] }, + "requester": { + "type": [ + "null" + ] + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -686946,10 +689395,7 @@ }, "required": [ "action", - "changes", - "issue", - "comment", - "repository", + "installation", "sender" ] } @@ -686964,22 +689410,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-assigned": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" }, "parameters": [ { @@ -687044,110 +689488,558 @@ "content": { "application/json": { "schema": { - "title": "issues assigned event", + "title": "issue_comment created event", "type": "object", "properties": { "action": { - "description": "The action that was performed.", "type": "string", "enum": [ - "assigned" + "created" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments) itself.", + "type": "object", "properties": { - "avatar_url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" + "body": { + "description": "Contents of the issue comment", + "type": "string" }, - "gists_url": { + "created_at": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "format": "date-time" }, "html_url": { "type": "string", "format": "uri" }, "id": { + "description": "Unique identifier of the issue comment", "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { + "issue_url": { "type": "string", "format": "uri" }, - "received_events_url": { - "type": "string", - "format": "uri" + "node_id": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] }, - "site_admin": { - "type": "boolean" + "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" + ] }, - "starred_url": { + "updated_at": { "type": "string", - "format": "uri-template" + "format": "date-time" }, - "subscriptions_url": { + "url": { + "description": "URL for the issue comment", "type": "string", "format": "uri" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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": [ - "login", - "id" + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" ] }, "enterprise": { @@ -687266,350 +690158,27 @@ ] }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -687706,189 +690275,1000 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { + "comments": { "type": "integer" }, - "labels_url": { + "comments_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "draft": { + "type": "boolean" }, - "open_issues": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "html_url": { "type": "string", - "enum": [ - "open", - "closed" - ] + "format": "uri" }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "id": { + "type": "integer" }, - "updated_at": { - "type": "string", - "format": "date-time" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "url": { + "labels_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -687971,7 +691351,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -687983,515 +691364,375 @@ "login", "id" ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "deleted": { + "type": "boolean" }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "organization_projects": { + "events_url": { "type": "string", - "enum": [ - "read", - "write", - "admin" - ] + "format": "uri-template" }, - "organization_secrets": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_self_hosted_runners": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_user_blocking": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gravatar_id": { + "type": "string" }, - "pages": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] + "login": { + "type": "string" }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] + "name": { + "type": "string" }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "secrets": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_events": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_scanning_alert": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "statuses": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "team_discussions": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "vulnerability_alerts": { + "type": { "type": "string", "enum": [ - "read", - "write" + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "workflows": { + "url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] } }, - "slug": { - "description": "The slug name of the GitHub app", + "author_association": { "type": "string" }, - "updated_at": { + "body": { "type": [ "string", "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" + ] }, - "merged_at": { + "closed_at": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" + ] }, - "confused": { + "comments": { "type": "integer" }, - "eyes": { - "type": "integer" + "comments_url": { + "type": "string" }, - "heart": { - "type": "integer" + "created_at": { + "type": "string" }, - "hooray": { - "type": "integer" + "events_url": { + "type": "string" }, - "laugh": { - "type": "integer" + "html_url": { + "type": "string" }, - "rocket": { + "id": { "type": "integer" }, - "total_count": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "labels_url": { + "type": "string" }, - "deleted": { + "locked": { "type": "boolean" }, - "email": { + "milestone": { "type": [ - "string", + "object", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "node_id": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "following_url": { - "type": "string", - "format": "uri-template" + "performed_via_github_app": { + "type": [ + "object", + "null" + ] }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "gravatar_id": { + "repository_url": { "type": "string" }, - "html_url": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" + "enum": [ + "open", + "closed" + ] }, - "login": { + "timeline_url": { "type": "string" }, - "name": { + "title": { "type": "string" }, - "node_id": { + "updated_at": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" + "labels", + "state", + "locked", + "assignee" ] } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" ] }, "organization": { @@ -690227,6 +693468,7 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] @@ -690242,7 +693484,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-comment", "supported-webhook-types": [ "repository", "organization", @@ -690251,13 +693493,13 @@ } } }, - "issues-closed": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" }, "parameters": [ { @@ -690322,189 +693564,734 @@ "content": { "application/json": { "schema": { - "title": "issues closed event", + "title": "issue_comment deleted event", "type": "object", "properties": { "action": { - "description": "The action that was performed.", "type": "string", "enum": [ - "closed" + "deleted" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments) itself.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "body": { + "description": "Contents of the issue comment", + "type": "string" }, - "name": { - "description": "The name of the enterprise.", + "created_at": { "type": "string", - "examples": [ - "Octo Business" - ] + "format": "date-time" }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "html_url": { "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "format": "uri" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer" }, - "avatar_url": { + "issue_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. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] }, "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", "properties": { - "avatar_url": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "format": "uri" + "examples": [ + "probot-owners" + ] }, - "deleted": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] }, - "email": { + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "The description of the app." ] }, - "events_url": { + "external_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://example.com" + ] }, - "followers_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] }, - "following_url": { + "created_at": { "type": "string", - "format": "uri-template" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] }, - "gists_url": { + "updated_at": { "type": "string", - "format": "uri-template" + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] }, - "gravatar_id": { + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, "html_url": { @@ -691042,10 +694829,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -691297,8 +695081,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -691690,9 +695473,100 @@ ] }, "assignee": { + "title": "User", "type": [ "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, "assignees": { @@ -691740,9 +695614,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] } }, @@ -691809,10 +695720,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -691888,8 +695800,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -693627,6 +697541,7 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] @@ -693642,7 +697557,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-comment", "supported-webhook-types": [ "repository", "organization", @@ -693651,13 +697566,13 @@ } } }, - "issues-deleted": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment" }, "parameters": [ { @@ -693722,149 +697637,467 @@ "content": { "application/json": { "schema": { - "title": "issues deleted event", + "title": "issue_comment edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "edited" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "changes": { + "description": "The changes to the comment.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" ] - }, - "html_url": { + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", "format": "uri" }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "description": "Unique identifier of the issue comment", + "type": "integer" }, - "node_id": { + "issue_url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri" }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] + "node_id": { + "type": "string" }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] + "format": "date-time" }, - "node_id": { - "description": "The global node ID of the installation.", + "url": { + "description": "URL for the issue comment", "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] + "format": "uri" }, - "assignee": { + "user": { "title": "User", "type": [ "object", @@ -693947,7 +698180,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -693959,236 +698193,160 @@ "login", "id" ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", "type": [ "string", "null" ] }, - "closed_at": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", "format": "uri" }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "events_url": { + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "html_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } + "examples": [ + "Octo Business" + ] }, - "labels_url": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", - "format": "uri-template" + "examples": [ + "octo-business" + ] }, - "locked": { - "type": "boolean" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "updated_at": { "type": [ - "object", + "string", "null" ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", "properties": { - "closed_at": { + "active_lock_reason": { "type": [ "string", "null" ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -694271,7 +698429,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -694284,188 +698443,999 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "labels_url": { + "draft": { + "type": "boolean" + }, + "events_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "number": { - "description": "The number of the milestone.", + "id": { "type": "integer" }, - "open_issues": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "state": { - "description": "The state of the milestone.", + "labels_url": { "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "format": "uri-template" }, - "updated_at": { - "type": "string", - "format": "date-time" + "locked": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -694548,7 +699518,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -694560,513 +699531,375 @@ "login", "id" ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { + "avatar_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "deleted": { + "type": "boolean" }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" + "email": { + "type": [ + "string", + "null" ] }, - "organization_projects": { + "events_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_secrets": { + "followers_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_self_hosted_runners": { + "following_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "organization_user_blocking": { + "gists_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gravatar_id": { + "type": "string" }, - "pages": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] + "login": { + "type": "string" }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] + "name": { + "type": "string" }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "secrets": { + "organizations_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_events": { + "received_events_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "security_scanning_alert": { + "repos_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "site_admin": { + "type": "boolean" }, - "statuses": { + "starred_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri-template" }, - "team_discussions": { + "subscriptions_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "vulnerability_alerts": { + "type": { "type": "string", "enum": [ - "read", - "write" + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "workflows": { + "url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] } }, - "slug": { - "description": "The slug name of the GitHub app", + "author_association": { "type": "string" }, - "updated_at": { + "body": { "type": [ "string", "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" + ] }, - "merged_at": { + "closed_at": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" + ] }, - "confused": { + "comments": { "type": "integer" }, - "eyes": { - "type": "integer" + "comments_url": { + "type": "string" }, - "heart": { - "type": "integer" + "created_at": { + "type": "string" }, - "hooray": { - "type": "integer" + "events_url": { + "type": "string" }, - "laugh": { - "type": "integer" + "html_url": { + "type": "string" }, - "rocket": { + "id": { "type": "integer" }, - "total_count": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "labels_url": { + "type": "string" }, - "deleted": { + "locked": { "type": "boolean" }, - "email": { + "milestone": { "type": [ - "string", + "object", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "node_id": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "following_url": { - "type": "string", - "format": "uri-template" + "performed_via_github_app": { + "type": [ + "object", + "null" + ] }, - "gists_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "gravatar_id": { + "repository_url": { "type": "string" }, - "html_url": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" + "enum": [ + "open", + "closed" + ] }, - "login": { + "timeline_url": { "type": "string" }, - "name": { + "title": { "type": "string" }, - "node_id": { + "updated_at": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } ] }, "organization": { @@ -696801,7 +701634,9 @@ }, "required": [ "action", + "changes", "issue", + "comment", "repository", "sender" ] @@ -696817,7 +701652,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-comment", "supported-webhook-types": [ "repository", "organization", @@ -696826,11 +701661,11 @@ } } }, - "issues-demilestoned": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -696897,13 +701732,110 @@ "content": { "application/json": { "schema": { - "title": "issues demilestoned event", + "title": "issues assigned event", "type": "object", "properties": { "action": { + "description": "The action that was performed.", "type": "string", "enum": [ - "demilestoned" + "assigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -697022,26 +701954,350 @@ ] }, "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "assignee": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -697138,153 +702394,19 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + "description": { "type": [ "string", "null" ] }, - "closed_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time" }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, "html_url": { "type": "string", "format": "uri" @@ -697292,831 +702414,30 @@ "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, "labels_url": { "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] + "format": "uri" }, "node_id": { "type": "string" }, "number": { + "description": "The number of the milestone.", "type": "integer" }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ] }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, "title": { - "description": "Title of the issue", + "description": "The title of the milestone.", "type": "string" }, "updated_at": { @@ -698124,11 +702445,138 @@ "format": "date-time" }, "url": { - "description": "URL for the issue", "type": "string", "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "user": { + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -698211,8 +702659,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -698224,448 +702671,396 @@ "login", "id" ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { + "actions": { "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "enum": [ + "read", + "write" ] }, - "description": { - "type": [ - "string", - "null" + "administration": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { + "checks": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "labels_url": { + "content_references": { "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "open_issues": { - "type": "integer" + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "state": { - "description": "The state of the milestone.", + "deployments": { "type": "string", "enum": [ - "open", - "closed" + "read", + "write" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "updated_at": { + "emails": { "type": "string", - "format": "date-time" + "enum": [ + "read", + "write" + ] }, - "url": { + "environments": { "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "-1": { - "type": "integer" + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "confused": { - "type": "integer" + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "eyes": { - "type": "integer" + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "heart": { - "type": "integer" + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "hooray": { - "type": "integer" + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "laugh": { - "type": "integer" + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "rocket": { - "type": "integer" + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "total_count": { - "type": "integer" + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] }, - "events_url": { - "type": "string" + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "followers_url": { - "type": "string" + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "following_url": { - "type": "string" + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "gists_url": { - "type": "string" + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "gravatar_id": { - "type": "string" + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "html_url": { - "type": "string" + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "id": { - "type": "integer" + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "login": { - "type": "string" + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "node_id": { - "type": "string" + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "organizations_url": { - "type": "string" + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "received_events_url": { - "type": "string" + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "repos_url": { - "type": "string" + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "site_admin": { - "type": "boolean" + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "starred_url": { - "type": "string" + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "subscriptions_url": { - "type": "string" + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "type": { - "type": "string" + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "url": { - "type": "string" + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] } } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "milestone" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] - } - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "timeline_url": { + "type": "string", + "format": "uri" }, - "created_at": { + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { "type": "string", "format": "date-time" }, - "creator": { + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -698761,79 +703156,30 @@ "login", "id" ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ "url", - "html_url", + "repository_url", "labels_url", + "comments_url", + "events_url", + "html_url", "id", "node_id", "number", "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", + "user", + "assignees", + "milestone", + "comments", "created_at", "updated_at", - "due_on", - "closed_at" + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, "organization": { @@ -700593,11 +704939,11 @@ } } }, - "issues-edited": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -700664,45 +705010,16 @@ "content": { "application/json": { "schema": { - "title": "issues edited event", + "title": "issues closed event", "type": "object", "properties": { "action": { + "description": "The action that was performed.", "type": "string", "enum": [ - "edited" + "closed" ] }, - "changes": { - "description": "The changes to the issue.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -700819,350 +705136,27 @@ ] }, "issue": { - "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -701259,190 +705253,1000 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "labels_url": { + "draft": { + "type": "boolean" + }, + "events_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "number": { - "description": "The number of the milestone.", + "id": { "type": "integer" }, - "open_issues": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "state": { - "description": "The state of the milestone.", + "labels_url": { "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "format": "uri-template" }, - "updated_at": { - "type": "string", - "format": "date-time" + "locked": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -701525,7 +706329,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -701537,558 +706342,244 @@ "login", "id" ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", "created_at", - "updated_at" + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, - "pull_request": { + { "type": "object", "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { + "active_lock_reason": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" + ] }, - "total_count": { - "type": "integer" + "assignee": { + "type": [ + "object", + "null" + ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "deleted": { - "type": "boolean" + "author_association": { + "type": "string" }, - "email": { + "body": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "closed_at": { + "type": [ + "string", + "null" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "comments": { + "type": "integer" }, - "following_url": { - "type": "string", - "format": "uri-template" + "comments_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "created_at": { + "type": "string" }, - "gravatar_id": { + "events_url": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, - "login": { - "type": "string" + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "name": { + "labels_url": { "type": "string" }, - "node_id": { - "type": "string" + "locked": { + "type": "boolean" }, - "organizations_url": { - "type": "string", - "format": "uri" + "milestone": { + "type": [ + "object", + "null" + ] }, - "received_events_url": { - "type": "string", - "format": "uri" + "node_id": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "performed_via_github_app": { + "type": [ + "object", + "null" + ] }, - "starred_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "repository_url": { + "type": "string" }, - "type": { + "state": { "type": "string", "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "closed", + "open" ] }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" + "state", + "closed_at" ] - }, - "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" ] }, "organization": { @@ -703823,7 +708314,6 @@ }, "required": [ "action", - "changes", "issue", "repository", "sender" @@ -703849,11 +708339,11 @@ } } }, - "issues-labeled": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -703920,13 +708410,13 @@ "content": { "application/json": { "schema": { - "title": "issues labeled event", + "title": "issues deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "labeled" + "deleted" ] }, "enterprise": { @@ -704145,8 +708635,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -704244,8 +708733,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -704471,8 +708959,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -704637,7 +709124,6 @@ "watch", "workflow_dispatch", "workflow_run", - "pull_request_review_thread", "reminder" ] } @@ -704890,8 +709376,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -705234,8 +709719,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -705273,49 +709757,6 @@ "reactions" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -707073,11 +711514,11 @@ } } }, - "issues-locked": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -707144,13 +711585,13 @@ "content": { "application/json": { "schema": { - "title": "issues locked event", + "title": "issues demilestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "locked" + "demilestoned" ] }, "enterprise": { @@ -707371,7 +711812,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -707469,7 +711911,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -707695,7 +712138,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -707859,9 +712303,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "security_and_analysis" + "workflow_run" ] } }, @@ -708113,7 +712555,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -708456,7 +712899,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -708501,13 +712945,6 @@ "type": [ "string", "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null ] }, "assignee": { @@ -708571,15 +713008,199 @@ "type": "string" }, "locked": { - "type": "boolean", - "enum": [ - true - ] + "type": "boolean" }, "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ "object", "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "node_id": { @@ -708708,10 +713329,199 @@ } }, "required": [ - "locked", - "active_lock_reason" + "milestone" + ] + } + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" ] }, "organization": { @@ -710471,11 +715281,11 @@ } } }, - "issues-milestoned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -710542,15 +715352,45 @@ "content": { "application/json": { "schema": { - "title": "issues milestoned event", + "title": "issues edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "milestoned" + "edited" ] }, + "changes": { + "description": "The changes to the issue.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -710667,26 +715507,350 @@ ] }, "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "assignee": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -710769,7 +715933,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -710782,152 +715947,19 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + "description": { "type": [ "string", "null" ] }, - "closed_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time" }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, "html_url": { "type": "string", "format": "uri" @@ -710935,832 +715967,30 @@ "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, "labels_url": { "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] + "format": "uri" }, "node_id": { "type": "string" }, "number": { + "description": "The number of the milestone.", "type": "integer" }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ] }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, "title": { - "description": "Title of the issue", + "description": "The title of the milestone.", "type": "string" }, "updated_at": { @@ -711768,11 +715998,139 @@ "format": "date-time" }, "url": { - "description": "URL for the issue", "type": "string", "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "user": { + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -711867,445 +716225,396 @@ "login", "id" ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - { - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "author_association": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "labels_url": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { + "actions": { "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "enum": [ + "read", + "write" ] }, - "description": { - "type": [ - "string", - "null" + "administration": { + "type": "string", + "enum": [ + "read", + "write" ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { + "checks": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "labels_url": { + "content_references": { "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "open_issues": { - "type": "integer" + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "state": { - "description": "The state of the milestone.", + "deployments": { "type": "string", "enum": [ - "open", - "closed" + "read", + "write" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "updated_at": { + "emails": { "type": "string", - "format": "date-time" + "enum": [ + "read", + "write" + ] }, - "url": { + "environments": { "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "type": [ - "object", - "null" - ] - }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" + "enum": [ + "read", + "write" + ] }, - "-1": { - "type": "integer" + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "confused": { - "type": "integer" + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "eyes": { - "type": "integer" + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "heart": { - "type": "integer" + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "hooray": { - "type": "integer" + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "laugh": { - "type": "integer" + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "rocket": { - "type": "integer" + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "total_count": { - "type": "integer" + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] }, - "events_url": { - "type": "string" + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "followers_url": { - "type": "string" + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "following_url": { - "type": "string" + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "gists_url": { - "type": "string" + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "gravatar_id": { - "type": "string" + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "html_url": { - "type": "string" + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "id": { - "type": "integer" + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "login": { - "type": "string" + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "node_id": { - "type": "string" + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "organizations_url": { - "type": "string" + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "received_events_url": { - "type": "string" + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "repos_url": { - "type": "string" + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "site_admin": { - "type": "boolean" + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "starred_url": { - "type": "string" + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "subscriptions_url": { - "type": "string" + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "type": { - "type": "string" + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] }, - "url": { - "type": "string" + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] } } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "milestone" + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] - } - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { - "type": "integer" + "timeline_url": { + "type": "string", + "format": "uri" }, - "created_at": { + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { "type": "string", "format": "date-time" }, - "creator": { + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -712401,6 +716710,42 @@ "login", "id" ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" }, "description": { "type": [ @@ -712408,72 +716753,30 @@ "null" ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { + "name": { + "description": "The name of the label.", "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.", + "node_id": { "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" - }, "url": { + "description": "URL for the label", "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" + "url", + "name", + "color", + "default", + "description" ] }, "organization": { @@ -714208,8 +718511,8 @@ }, "required": [ "action", + "changes", "issue", - "milestone", "repository", "sender" ] @@ -714234,11 +718537,11 @@ } } }, - "issues-opened": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -714305,40 +718608,475 @@ "content": { "application/json": { "schema": { - "title": "issues opened event", + "title": "issues labeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "opened" + "labeled" ] }, - "changes": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "old_issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", "type": [ "object", "null" ], "properties": { - "active_lock_reason": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "assignee": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -714421,7 +719159,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -714434,152 +719173,19 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + "description": { "type": [ "string", "null" ] }, - "closed_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time" }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, "html_url": { "type": "string", "format": "uri" @@ -714587,829 +719193,30 @@ "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, "labels_url": { "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] + "format": "uri" }, "node_id": { "type": "string" }, "number": { + "description": "The number of the milestone.", "type": "integer" }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ] }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, "title": { - "description": "Title of the issue", + "description": "The title of the milestone.", "type": "string" }, "updated_at": { @@ -715417,11 +719224,138 @@ "format": "date-time" }, "url": { - "description": "URL for the issue", + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { "type": "string", "format": "uri" }, - "user": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -715516,531 +719450,1808 @@ "login", "id" ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "updated_at" ] }, - "old_repository": { - "title": "Repository", - "description": "A git repository", + "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": { + "diff_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": { + "html_url": { "type": "string", "format": "uri" }, - "description": { + "merged_at": { "type": [ "string", "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" + ], + "format": "date-time" }, - "downloads_url": { + "patch_url": { "type": "string", "format": "uri" }, - "events_url": { + "url": { "type": "string", "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "fork": { - "type": "boolean" + "-1": { + "type": "integer" }, - "forks": { + "confused": { "type": "integer" }, - "forks_count": { + "eyes": { "type": "integer" }, - "forks_url": { - "type": "string", - "format": "uri" + "heart": { + "type": "integer" }, - "full_name": { - "type": "string" + "hooray": { + "type": "integer" }, - "git_commits_url": { - "type": "string", - "format": "uri-template" + "laugh": { + "type": "integer" }, - "git_refs_url": { - "type": "string", - "format": "uri-template" + "rocket": { + "type": "integer" }, - "git_tags_url": { - "type": "string", - "format": "uri-template" + "total_count": { + "type": "integer" }, - "git_url": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { "type": "string", "format": "uri" }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { + "deleted": { "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 - }, - "homepage": { + "email": { "type": [ "string", "null" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri" + "format": "uri-template" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { + "following_url": { "type": "string", "format": "uri-template" }, - "issues_url": { + "gists_url": { "type": "string", "format": "uri-template" }, - "keys_url": { - "type": "string", - "format": "uri-template" + "gravatar_id": { + "type": "string" }, - "labels_url": { + "html_url": { "type": "string", - "format": "uri-template" + "format": "uri" }, - "language": { - "type": [ - "string", - "null" - ] + "id": { + "type": "integer" }, - "languages_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] + "name": { + "type": "string" }, - "master_branch": { + "node_id": { "type": "string" }, - "merges_url": { + "organizations_url": { "type": "string", "format": "uri" }, - "milestones_url": { + "received_events_url": { "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri" }, - "name": { - "description": "The name of the repository.", - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "node_id": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "notifications_url": { + "starred_url": { "type": "string", "format": "uri-template" }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "organization": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", "properties": { - "avatar_url": { + "key": { "type": "string", - "format": "uri" + "examples": [ + "mit" + ] }, - "deleted": { - "type": "boolean" + "name": { + "type": "string", + "examples": [ + "MIT License" + ] }, - "email": { + "url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" ] }, - "events_url": { + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "followers_url": { + "html_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "following_url": { + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "gists_url": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "id": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "login": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "name": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "organizations_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "received_events_url": { + "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, "repos_url": { "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "starred_url": { + "events_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "examples": [ + "User" ] }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", "login", - "id" + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "permissions": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { "type": "object", "properties": { - "admin": { - "type": "boolean" + "login": { + "type": "string" }, - "maintain": { - "type": "boolean" + "id": { + "type": "integer" }, - "pull": { - "type": "boolean" + "node_id": { + "type": "string" }, - "push": { - "type": "boolean" + "avatar_url": { + "type": "string" }, - "triage": { + "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" } - }, - "required": [ - "pull", - "push", - "admin" - ] + } }, "private": { - "description": "Whether the repository is private or public.", "type": "boolean" }, - "public": { + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { "type": "boolean" }, - "pulls_url": { - "type": "string", - "format": "uri-template" + "url": { + "type": "string" }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] + "archive_url": { + "type": "string" }, - "releases_url": { - "type": "string", - "format": "uri-template" + "assignees_url": { + "type": "string" }, - "role_name": { - "type": [ - "string", - "null" - ] + "blobs_url": { + "type": "string" }, - "size": { - "type": "integer" + "branches_url": { + "type": "string" }, - "ssh_url": { + "collaborators_url": { "type": "string" }, - "stargazers": { - "type": "integer" + "comments_url": { + "type": "string" }, - "stargazers_count": { - "type": "integer" + "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", - "format": "uri" + "type": "string" }, "statuses_url": { - "type": "string", - "format": "uri-template" + "type": "string" }, "subscribers_url": { - "type": "string", - "format": "uri" + "type": "string" }, "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" + "type": "string" }, "tags_url": { - "type": "string", - "format": "uri" + "type": "string" }, "teams_url": { - "type": "string", - "format": "uri" + "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", @@ -716048,114 +721259,586 @@ "type": "string" } }, - "trees_url": { - "type": "string", - "format": "uri-template" + "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", - "format": "date-time" + "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)." }, - "url": { + "squash_merge_commit_message": { "type": "string", - "format": "uri" + "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." }, - "visibility": { + "merge_commit_title": { "type": "string", "enum": [ - "public", - "private", - "internal" - ] + "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)." }, - "watchers": { + "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" }, - "watchers_count": { + "network_count": { "type": "integer" } - }, - "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", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "old_issue", - "old_repository" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-locked": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issues locked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "locked" ] }, "enterprise": { @@ -716700,8 +722383,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -716866,9 +722548,8 @@ "watch", "workflow_dispatch", "workflow_run", - "security_and_analysis", - "pull_request_review_thread", - "reminder" + "reminder", + "security_and_analysis" ] } }, @@ -717120,8 +722801,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -717509,6 +723189,13 @@ "type": [ "string", "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, "assignee": { @@ -717572,7 +723259,10 @@ "type": "string" }, "locked": { - "type": "boolean" + "type": "boolean", + "enum": [ + true + ] }, "milestone": { "type": [ @@ -717631,11 +723321,7 @@ "type": "string" }, "state": { - "type": "string", - "enum": [ - "open", - "closed" - ] + "type": "string" }, "timeline_url": { "type": "string" @@ -717710,8 +723396,8 @@ } }, "required": [ - "state", - "closed_at" + "locked", + "active_lock_reason" ] } ] @@ -719473,11 +725159,11 @@ } } }, - "issues-pinned": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -719544,13 +725230,13 @@ "content": { "application/json": { "schema": { - "title": "issues pinned event", + "title": "issues milestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pinned" + "milestoned" ] }, "enterprise": { @@ -719669,348 +725355,26 @@ ] }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -720106,187 +725470,997 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "labels_url": { + "draft": { + "type": "boolean" + }, + "events_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "number": { - "description": "The number of the milestone.", + "id": { "type": "integer" }, - "open_issues": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "state": { - "description": "The state of the milestone.", + "labels_url": { "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "format": "uri-template" }, - "updated_at": { - "type": "string", - "format": "date-time" + "locked": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -720381,402 +726555,452 @@ "login", "id" ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] + "closed_issues": { + "type": "integer" }, - "checks": { + "created_at": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" ] }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" + "description": { + "type": [ + "string", + "null" ] }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "discussions": { + "html_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "environments": { + "labels_url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] + "open_issues": { + "type": "integer" }, - "metadata": { + "state": { + "description": "The state of the milestone.", "type": "string", "enum": [ - "read", - "write" + "open", + "closed" ] }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] + "title": { + "description": "The title of the milestone.", + "type": "string" }, - "organization_hooks": { + "updated_at": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "organization_packages": { + "url": { "type": "string", - "enum": [ - "read", - "write" - ] + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] + "-1": { + "type": "integer" }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] + "confused": { + "type": "integer" }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] + "eyes": { + "type": "integer" }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] + "heart": { + "type": "integer" }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] + "hooray": { + "type": "integer" }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "laugh": { + "type": "integer" }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] + "rocket": { + "type": "integer" }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] + "total_count": { + "type": "integer" }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] + "events_url": { + "type": "string" }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "followers_url": { + "type": "string" }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] + "following_url": { + "type": "string" }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gists_url": { + "type": "string" }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] + "gravatar_id": { + "type": "string" }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] + "html_url": { + "type": "string" }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] + "id": { + "type": "integer" }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] + "login": { + "type": "string" }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] + "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" } } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" + "milestone" ] + } + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "pull_request": { - "type": "object", + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { + "avatar_url": { "type": "string", "format": "uri" }, @@ -720852,7 +727076,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -720864,30 +727089,79 @@ "login", "id" ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", "html_url", + "labels_url", "id", "node_id", "number", "title", - "user", - "assignees", - "milestone", - "comments", + "description", + "creator", + "open_issues", + "closed_issues", + "state", "created_at", "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "due_on", + "closed_at" ] }, "organization": { @@ -722623,6 +728897,7 @@ "required": [ "action", "issue", + "milestone", "repository", "sender" ] @@ -722647,11 +728922,11 @@ } } }, - "issues-reopened": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -722718,136 +728993,25 @@ "content": { "application/json": { "schema": { - "title": "issues reopened event", + "title": "issues opened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "opened" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "changes": { "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { + "old_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", "type": [ - "string", + "object", "null" ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", "properties": { "active_lock_reason": { "type": [ @@ -723043,8 +729207,1962 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "old_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" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "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" + } + }, + "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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + } + }, + "required": [ + "old_issue", + "old_repository" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "issue": { + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -723436,6 +731554,7 @@ "watch", "workflow_dispatch", "workflow_run", + "security_and_analysis", "pull_request_review_thread", "reminder" ] @@ -723746,8 +731865,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -724034,8 +732152,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -724281,7 +732398,8 @@ } }, "required": [ - "state" + "state", + "closed_at" ] } ] @@ -726043,11 +734161,11 @@ } } }, - "issues-transferred": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -726114,1869 +734232,18 @@ "content": { "application/json": { "schema": { - "title": "issues transferred event", + "title": "issues pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "pinned" ] }, - "changes": { - "type": "object", - "properties": { - "new_issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - "new_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" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "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" - ] - } - }, - "required": [ - "new_issue", - "new_repository" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { @@ -731043,7 +737310,6 @@ }, "required": [ "action", - "changes", "issue", "repository", "sender" @@ -731069,11 +737335,11 @@ } } }, - "issues-unassigned": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -731140,111 +737406,13 @@ "content": { "application/json": { "schema": { - "title": "issues unassigned event", + "title": "issues reopened event", "type": "object", "properties": { "action": { - "description": "The action that was performed.", "type": "string", "enum": [ - "unassigned" - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" + "reopened" ] }, "enterprise": { @@ -731363,350 +737531,26 @@ ] }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "type": [ "string", "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", + ], "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { "title": "User", "type": [ "object", @@ -731789,8 +737633,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -731803,189 +737646,1000 @@ "id" ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, - "due_on": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, - "html_url": { + "comments": { + "type": "integer" + }, + "comments_url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "labels_url": { + "draft": { + "type": "boolean" + }, + "events_url": { "type": "string", "format": "uri" }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri" }, - "number": { - "description": "The number of the milestone.", + "id": { "type": "integer" }, - "open_issues": { - "type": "integer" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } }, - "state": { - "description": "The state of the milestone.", + "labels_url": { "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" + "format": "uri-template" }, - "updated_at": { - "type": "string", - "format": "date-time" + "locked": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": [ - "string", + "object", "null" ], - "format": "date-time" + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, - "description": { + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ - "string", + "object", "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" - ] + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } } }, - "external_url": { - "type": [ - "string", - "null" - ], - "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" + ] }, - "html_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "description": "Unique identifier of the GitHub app", + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { "type": [ - "integer", + "string", "null" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "title": { + "description": "Title of the issue", "type": "string" }, - "owner": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { "title": "User", "type": [ "object", @@ -732068,7 +738722,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -732080,515 +738735,243 @@ "login", "id" ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", "created_at", - "updated_at" + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, - "pull_request": { + { "type": "object", "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { + "active_lock_reason": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" + ] }, - "total_count": { - "type": "integer" + "assignee": { + "type": [ + "object", + "null" + ] }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "Title of the issue", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "deleted": { - "type": "boolean" + "author_association": { + "type": "string" }, - "email": { + "body": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "closed_at": { + "type": [ + "string", + "null" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "comments": { + "type": "integer" }, - "following_url": { - "type": "string", - "format": "uri-template" + "comments_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "created_at": { + "type": "string" }, - "gravatar_id": { + "events_url": { "type": "string" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, - "login": { - "type": "string" + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "name": { + "labels_url": { "type": "string" }, - "node_id": { - "type": "string" + "locked": { + "type": "boolean" }, - "organizations_url": { - "type": "string", - "format": "uri" + "milestone": { + "type": [ + "object", + "null" + ] }, - "received_events_url": { - "type": "string", - "format": "uri" + "node_id": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "performed_via_github_app": { + "type": [ + "object", + "null" + ] }, - "starred_url": { - "type": "string", - "format": "uri-template" + "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" + } + } }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "repository_url": { + "type": "string" }, - "type": { + "state": { "type": "string", "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "open", + "closed" ] }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" + "state" ] } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" ] }, "organization": { @@ -734348,11 +740731,11 @@ } } }, - "issues-unlabeled": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -734419,125 +740802,1976 @@ "content": { "application/json": { "schema": { - "title": "issues unlabeled event", + "title": "issues transferred event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "transferred" ] }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "changes": { "type": "object", "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, + "new_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "new_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" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "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" + ] + } + }, + "required": [ + "new_issue", + "new_repository" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, "required": [ "id", "node_id" @@ -734644,8 +742878,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -734743,8 +742976,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -734970,8 +743202,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -735135,9 +743366,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -735389,8 +743618,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -735733,8 +743961,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -735772,49 +743999,6 @@ "reactions" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -737547,6 +745731,7 @@ }, "required": [ "action", + "changes", "issue", "repository", "sender" @@ -737572,11 +745757,11 @@ } } }, - "issues-unlocked": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -737643,26 +745828,124 @@ "content": { "application/json": { "schema": { - "title": "issues unlocked event", + "title": "issues unassigned event", "type": "object", "properties": { "action": { + "description": "The action that was performed.", "type": "string", "enum": [ - "unlocked" + "unassigned" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, "html_url": { "type": "string", @@ -737768,26 +746051,350 @@ ] }, "issue": { - "allOf": [ - { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", - "type": "object", + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "active_lock_reason": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "assignee": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": [ "object", @@ -737870,7 +746477,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -737883,152 +746491,19 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "Contents of the issue", + "description": { "type": [ "string", "null" ] }, - "closed_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time" }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, "html_url": { "type": "string", "format": "uri" @@ -738036,829 +746511,30 @@ "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, "labels_url": { "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] + "format": "uri" }, "node_id": { "type": "string" }, "number": { + "description": "The number of the milestone.", "type": "integer" }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "diff_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ] }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, "title": { - "description": "Title of the issue", + "description": "The title of the milestone.", "type": "string" }, "updated_at": { @@ -738866,11 +746542,138 @@ "format": "date-time" }, "url": { - "description": "URL for the issue", + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { "type": "string", "format": "uri" }, - "user": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -738965,241 +746768,515 @@ "login", "id" ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" + "updated_at" ] }, - { + "pull_request": { "type": "object", "properties": { - "active_lock_reason": { - "type": [ - "null" - ] + "diff_url": { + "type": "string", + "format": "uri" }, - "assignee": { + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { "type": [ - "object", + "string", "null" - ] + ], + "format": "date-time" }, - "assignees": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } + "patch_url": { + "type": "string", + "format": "uri" }, - "author_association": { - "type": "string" + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" }, - "body": { - "type": [ - "string", - "null" - ] + "-1": { + "type": "integer" }, - "closed_at": { + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" ] }, - "comments": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "comments_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "created_at": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "events_url": { + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "labels_url": { + "login": { "type": "string" }, - "locked": { - "type": "boolean", - "enum": [ - false - ] - }, - "milestone": { - "type": [ - "object", - "null" - ] + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "performed_via_github_app": { - "type": [ - "null" + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "reactions": { - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "repository_url": { - "type": "string" - }, - "state": { - "type": "string" - }, - "timeline_url": { - "type": "string" - }, - "title": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "type": "string", + "format": "uri" } }, "required": [ - "locked", - "active_lock_reason" + "login", + "id" ] } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, "organization": { @@ -740959,11 +749036,11 @@ } } }, - "issues-unpinned": { + "issues-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, @@ -741030,13 +749107,13 @@ "content": { "application/json": { "schema": { - "title": "issues unpinned event", + "title": "issues unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unpinned" + "unlabeled" ] }, "enterprise": { @@ -741255,7 +749332,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -741353,7 +749431,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -741579,7 +749658,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -741743,7 +749823,9 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run" + "workflow_run", + "reminder", + "pull_request_review_thread" ] } }, @@ -741995,7 +750077,8 @@ "type": "string", "enum": [ "read", - "write" + "write", + "admin" ] }, "organization_secrets": { @@ -742338,7 +750421,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -742376,6 +750460,49 @@ "reactions" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -744133,13 +752260,13 @@ } } }, - "label-created": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -744204,13 +752331,13 @@ "content": { "application/json": { "schema": { - "title": "label created event", + "title": "issues unlocked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "unlocked" ] }, "enterprise": { @@ -744328,47 +752455,1439 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" + "issue": { + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, - "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" + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean", + "enum": [ + false + ] + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "null" + ] + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "locked", + "active_lock_reason" + ] } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" ] }, "organization": { @@ -746103,8 +755622,9 @@ }, "required": [ "action", - "label", - "repository" + "issue", + "repository", + "sender" ] } } @@ -746118,7 +755638,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -746127,13 +755647,13 @@ } } }, - "label-deleted": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -746198,13 +755718,13 @@ "content": { "application/json": { "schema": { - "title": "label deleted event", + "title": "issues unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "unpinned" ] }, "enterprise": { @@ -746322,47 +755842,1226 @@ "node_id" ] }, - "label": { - "title": "Label", + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/reference/issues) itself.", "type": "object", "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, - "default": { - "type": "boolean" + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, - "description": { + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", "type": [ "string", "null" ] }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { "type": "integer" }, - "name": { - "description": "The name of the label.", - "type": "string" + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] }, "node_id": { "type": "string" }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, "url": { - "description": "URL for the label", + "description": "URL for the issue", "type": "string", "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] } }, "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "url", - "name", - "color", - "default", - "description" + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" ] }, "organization": { @@ -748097,7 +758796,7 @@ }, "required": [ "action", - "label", + "issue", "repository", "sender" ] @@ -748113,7 +758812,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -748122,11 +758821,11 @@ } } }, - "label-edited": { + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" }, @@ -748193,57 +758892,15 @@ "content": { "application/json": { "schema": { - "title": "label edited event", + "title": "label created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "created" ] }, - "changes": { - "description": "The changes to the label if the action was `edited`.", - "type": "object", - "properties": { - "color": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the color if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "description": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the description 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" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -750135,8 +760792,7 @@ "required": [ "action", "label", - "repository", - "sender" + "repository" ] } } @@ -750159,13 +760815,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -750230,18 +760886,15 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase cancelled event", + "title": "label deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "cancelled" + "deleted" ] }, - "effective_date": { - "type": "string" - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -750357,215 +761010,47 @@ "node_id" ] }, - "marketplace_purchase": { - "allOf": [ - { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" }, - { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - } - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - } - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "next_billing_date" + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] }, "organization": { @@ -750667,119 +761152,6 @@ "description" ] }, - "previous_marketplace_purchase": { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -752413,9 +762785,9 @@ }, "required": [ "action", - "effective_date", - "sender", - "marketplace_purchase" + "label", + "repository", + "sender" ] } } @@ -752429,20 +762801,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace-purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -752507,17 +762881,56 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase changed event", + "title": "label edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "changed" + "edited" ] }, - "effective_date": { - "type": "string" + "changes": { + "description": "The changes to the label if the action was `edited`.", + "type": "object", + "properties": { + "color": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the color if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "description": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the description 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" + ] + } + } }, "enterprise": { "title": "Enterprise", @@ -752634,215 +763047,47 @@ "node_id" ] }, - "marketplace_purchase": { - "allOf": [ - { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" }, - { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - } - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": "boolean" - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - } - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "next_billing_date" + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" ] }, "organization": { @@ -752944,123 +763189,6 @@ "description" ] }, - "previous_marketplace_purchase": { - "title": "Marketplace Purchase", - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organization_billing_email": { - "type": [ - "string", - "null" - ] - }, - "type": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "node_id", - "login", - "organization_billing_email" - ] - }, - "billing_cycle": { - "type": "string" - }, - "free_trial_ends_on": { - "type": [ - "string", - "null" - ] - }, - "next_billing_date": { - "type": [ - "string", - "null" - ] - }, - "on_free_trial": { - "type": [ - "boolean", - "null" - ] - }, - "plan": { - "type": "object", - "properties": { - "bullets": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "has_free_trial": { - "type": "boolean" - }, - "id": { - "type": "integer" - }, - "monthly_price_in_cents": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "price_model": { - "type": "string" - }, - "unit_name": { - "type": [ - "string", - "null" - ] - }, - "yearly_price_in_cents": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "description", - "monthly_price_in_cents", - "yearly_price_in_cents", - "price_model", - "has_free_trial", - "unit_name", - "bullets" - ] - }, - "unit_count": { - "type": "integer" - } - }, - "required": [ - "account", - "billing_cycle", - "unit_count", - "on_free_trial", - "free_trial_ends_on", - "plan" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -754694,9 +764822,9 @@ }, "required": [ "action", - "effective_date", - "sender", - "marketplace_purchase" + "label", + "repository", + "sender" ] } } @@ -754710,18 +764838,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace-purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, @@ -754788,13 +764918,13 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase pending_change event", + "title": "marketplace_purchase cancelled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pending_change" + "cancelled" ] }, "effective_date": { @@ -755264,7 +765394,6 @@ }, "free_trial_ends_on": { "type": [ - "string", "null" ] }, @@ -756995,11 +767124,11 @@ } } }, - "marketplace-purchase-pending-change-cancelled": { + "marketplace-purchase-changed": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, @@ -757066,13 +767195,13 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase pending_change_cancelled event", + "title": "marketplace_purchase changed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "pending_change_cancelled" + "changed" ] }, "effective_date": { @@ -757234,6 +767363,7 @@ }, "free_trial_ends_on": { "type": [ + "string", "null" ] }, @@ -757311,8 +767441,90 @@ { "type": "object", "properties": { - "next_billing_date": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" } }, "required": [ @@ -757459,6 +767671,7 @@ }, "free_trial_ends_on": { "type": [ + "string", "null" ] }, @@ -757469,7 +767682,10 @@ ] }, "on_free_trial": { - "type": "boolean" + "type": [ + "boolean", + "null" + ] }, "plan": { "type": "object", @@ -759189,11 +769405,11 @@ } } }, - "marketplace-purchase-purchased": { + "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, @@ -759260,13 +769476,13 @@ "content": { "application/json": { "schema": { - "title": "marketplace_purchase purchased event", + "title": "marketplace_purchase pending_change event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "purchased" + "pending_change" ] }, "effective_date": { @@ -759736,6 +769952,7 @@ }, "free_trial_ends_on": { "type": [ + "string", "null" ] }, @@ -761466,13 +771683,13 @@ } } }, - "member-added": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, "parameters": [ { @@ -761537,35 +771754,17 @@ "content": { "application/json": { "schema": { - "title": "member added event", + "title": "marketplace_purchase pending_change_cancelled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "added" + "pending_change_cancelled" ] }, - "changes": { - "type": "object", - "properties": { - "permission": { - "type": "object", - "properties": { - "to": { - "type": "string", - "enum": [ - "write", - "admin", - "read" - ] - } - }, - "required": [ - "to" - ] - } - } + "effective_date": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -761682,100 +771881,132 @@ "node_id" ] }, - "member": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "marketplace_purchase": { + "allOf": [ + { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "type": "object", + "properties": { + "next_billing_date": { + "type": "string" + } + }, + "required": [ + "next_billing_date" ] - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "login", - "id" ] }, "organization": { @@ -761877,6 +772108,119 @@ "description" ] }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -763510,9 +773854,9 @@ }, "required": [ "action", - "member", - "repository", - "sender" + "effective_date", + "sender", + "marketplace_purchase" ] } } @@ -763526,23 +773870,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace-purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-edited": { + "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase" }, "parameters": [ { @@ -763607,49 +773948,17 @@ "content": { "application/json": { "schema": { - "title": "member edited event", + "title": "marketplace_purchase purchased event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "purchased" ] }, - "changes": { - "description": "The changes to the collaborator permissions", - "type": "object", - "properties": { - "old_permission": { - "type": "object", - "properties": { - "from": { - "description": "The previous permissions of the collaborator if the action was edited.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "permission": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - }, - "to": { - "type": [ - "string", - "null" - ] - } - } - } - } + "effective_date": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -763766,100 +774075,215 @@ "node_id" ] }, - "member": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "marketplace_purchase": { + "allOf": [ + { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "string", + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "next_billing_date" ] - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "login", - "id" ] }, "organization": { @@ -763961,6 +774385,119 @@ "description" ] }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": [ + "null" + ] + }, + "next_billing_date": { + "type": [ + "string", + "null" + ] + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string" + }, + "unit_name": { + "type": [ + "string", + "null" + ] + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -765594,10 +776131,9 @@ }, "required": [ "action", - "changes", - "member", - "repository", - "sender" + "effective_date", + "sender", + "marketplace_purchase" ] } } @@ -765611,21 +776147,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "marketplace-purchase", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "member-removed": { + "member-added": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" }, @@ -765692,15 +776225,36 @@ "content": { "application/json": { "schema": { - "title": "member removed event", + "title": "member added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "removed" + "added" ] }, + "changes": { + "type": "object", + "properties": { + "permission": { + "type": "object", + "properties": { + "to": { + "type": "string", + "enum": [ + "write", + "admin", + "read" + ] + } + }, + "required": [ + "to" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -767670,13 +778224,13 @@ } } }, - "membership-added": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -767741,15 +778295,50 @@ "content": { "application/json": { "schema": { - "title": "membership added event", + "title": "member edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "added" + "edited" ] }, + "changes": { + "description": "The changes to the collaborator permissions", + "type": "object", + "properties": { + "old_permission": { + "type": "object", + "properties": { + "from": { + "description": "The previous permissions of the collaborator if the action was edited.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "permission": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": [ + "string", + "null" + ] + } + } + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -769529,26 +780118,16 @@ "updated_at" ] }, - "scope": { - "description": "The scope of the membership. Currently, can only be `team`.", - "type": "string", - "enum": [ - "team" - ] - }, "sender": { - "title": "User", - "type": [ - "object", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -769556,225 +780135,157 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "html_url": { + "url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "organizations_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "received_events_url": { + "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "repos_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "site_admin": { - "type": "boolean" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, "starred_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, "subscriptions_url": { "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "url": { + "organizations_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "html_url": { + "repos_url": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "members_url": { + "events_url": { "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { + "received_events_url": { "type": "string", - "enum": [ - "open", - "closed", - "secret" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "repositories_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, - "slug": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "url": { - "description": "URL for the team", + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "name", - "id" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", - "scope", + "changes", "member", - "sender", - "team", - "organization" + "repository", + "sender" ] } } @@ -769788,22 +780299,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -769868,7 +780380,7 @@ "content": { "application/json": { "schema": { - "title": "membership removed event", + "title": "member removed event", "type": "object", "properties": { "action": { @@ -771656,27 +782168,16 @@ "updated_at" ] }, - "scope": { - "description": "The scope of the membership. Currently, can only be `team`.", - "type": "string", - "enum": [ - "team", - "organization" - ] - }, "sender": { - "title": "User", - "type": [ - "object", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, "email": { "type": [ @@ -771684,225 +782185,156 @@ "null" ] }, - "events_url": { + "login": { "type": "string", - "format": "uri-template" + "examples": [ + "octocat" + ] }, - "followers_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "following_url": { + "node_id": { "type": "string", - "format": "uri-template" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "gists_url": { + "avatar_url": { "type": "string", - "format": "uri-template" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, "gravatar_id": { - "type": "string" + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "html_url": { + "url": { "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "organizations_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "received_events_url": { + "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "repos_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "site_admin": { - "type": "boolean" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, "starred_url": { "type": "string", - "format": "uri-template" + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, "subscriptions_url": { "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "url": { + "organizations_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "html_url": { + "repos_url": { "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "members_url": { + "events_url": { "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { + "received_events_url": { "type": "string", - "enum": [ - "open", - "closed", - "secret" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" ] }, - "repositories_url": { + "type": { "type": "string", - "format": "uri" + "examples": [ + "User" + ] }, - "slug": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "url": { - "description": "URL for the team", + "starred_at": { "type": "string", - "format": "uri" + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "name", - "id" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", - "scope", "member", - "sender", - "team", - "organization" + "repository", + "sender" ] } } @@ -771916,25 +782348,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "merge-group-checks-requested": { + "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -771999,10 +782429,104 @@ "content": { "application/json": { "schema": { + "title": "membership added event", "type": "object", "properties": { "action": { - "type": "string" + "type": "string", + "enum": [ + "added" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] }, "installation": { "title": "Simple Installation", @@ -772029,117 +782553,100 @@ "node_id" ] }, - "merge_group": { - "title": "MergeGroup", - "type": "object", + "member": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "head_sha": { - "description": "The SHA of the merge group.", + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "head_ref": { - "description": "The full ref of the merge group.", + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { "type": "string" }, - "base_sha": { - "description": "The SHA of the merge group's parent commit.", + "name": { "type": "string" }, - "base_ref": { - "description": "The full ref of the branch the merge group will be merged into.", + "node_id": { "type": "string" }, - "head_commit": { - "title": "SimpleCommit", - "type": "object", - "properties": { - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "id": { - "type": "string" - }, - "message": { - "type": "string" - }, - "timestamp": { - "type": "string" - }, - "tree_id": { - "type": "string" - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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": [ - "head_sha", - "head_ref", - "base_sha", - "base_ref", - "head_commit" + "login", + "id" ] }, "organization": { @@ -773710,16 +784217,26 @@ "updated_at" ] }, + "scope": { + "description": "The scope of the membership. Currently, can only be `team`.", + "type": "string", + "enum": [ + "team" + ] + }, "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -773727,154 +784244,225 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] + "format": "uri-template" }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "node_id": { + "following_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri-template" }, - "avatar_url": { + "gists_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "uri-template" }, "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "format": "uri" }, - "following_url": { + "received_events_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri" }, - "gists_url": { + "repos_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri" + }, + "site_admin": { + "type": "boolean" }, "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "format": "uri-template" }, "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" ] }, - "events_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] }, - "type": { + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { "type": "string", - "examples": [ - "User" + "enum": [ + "open", + "closed", + "secret" ] }, - "site_admin": { - "type": "boolean" + "repositories_url": { + "type": "string", + "format": "uri" }, - "starred_at": { + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name", + "id" ] } }, "required": [ "action", - "merge_group" + "scope", + "member", + "sender", + "team", + "organization" ] } } @@ -773888,20 +784476,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge-group", + "subcategory": "membership", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "meta-deleted": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -773966,13 +784556,13 @@ "content": { "application/json": { "schema": { - "title": "meta deleted event", + "title": "membership removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "removed" ] }, "enterprise": { @@ -774065,132 +784655,6 @@ "avatar_url" ] }, - "hook": { - "description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.", - "type": "object", - "properties": { - "active": { - "type": "boolean" - }, - "config": { - "type": "object", - "properties": { - "content_type": { - "type": "string", - "enum": [ - "json", - "form" - ] - }, - "insecure_ssl": { - "type": "string" - }, - "secret": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "content_type", - "insecure_ssl", - "url" - ] - }, - "created_at": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "*", - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "create", - "delete", - "deployment", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "meta", - "milestone", - "organization", - "org_block", - "package", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "pull_request_review_thread", - "push", - "registry_package", - "release", - "repository", - "repository_import", - "repository_vulnerability_alert", - "secret_scanning_alert", - "secret_scanning_alert_location", - "security_and_analysis", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_job", - "workflow_run", - "repository_dispatch", - "projects_v2_item" - ], - "minItems": 1 - } - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "type", - "id", - "name", - "active", - "events", - "config", - "updated_at", - "created_at" - ] - }, - "hook_id": { - "description": "The id of the modified webhook.", - "type": "integer" - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -774216,6 +784680,102 @@ "node_id" ] }, + "member": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -774316,300 +784876,104 @@ ] }, "repository": { - "anyOf": [ - { - "type": "null" + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name": { + "type": "string", + "examples": [ + "MIT License" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "triage": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "push": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "maintain": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -774769,363 +785133,897 @@ "type", "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, + "pull": { "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "triage": { + "type": "boolean" }, - "description": { + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "octocat" ] }, - "archive_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + 1 ] }, - "assignees_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "MDQ6VXNlcjE=" ] }, - "blobs_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "branches_url": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat" ] }, - "collaborators_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://github.com/octocat" ] }, - "comments_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/followers" ] }, - "commits_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "forks_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/received_events" ] }, - "git_commits_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "User" ] }, - "git_refs_url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "\"2020-07-09T00:17:55Z\"" ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" }, "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "type": "string" }, "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "type": "string" }, "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] + "type": "string" }, "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] + "type": "string" }, "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] + "type": "string" }, "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "type": "string" }, "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] + "type": "string" }, "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] + "type": "string" }, "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] + "type": "string" }, "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] + "type": "string" }, "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "type": "string" }, "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] + "type": "string" }, "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "type": "string" }, "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] + "type": "string" }, "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] + "type": "string" }, "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] + "type": "string" }, "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] + "type": "string" }, "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] + "type": "string" }, "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "type": "string" }, "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] + "type": "string" }, "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "type": "string" }, "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] + "type": "string" }, "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] + "type": "string" }, "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "type": "string" }, "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] + "type": "string" }, "language": { - "type": [ - "string", - "null" - ] + "type": "string" }, "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "type": "integer" }, "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "type": "string" }, "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "topics": { "type": "array", @@ -775134,507 +786032,78 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "type": "string" }, "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "type": "string" }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "string" }, - "template_repository": { - "type": [ - "object", - "null" - ], + "permissions": { + "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": { + "admin": { "type": "boolean" }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { + "maintain": { "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" + "push": { + "type": "boolean" }, - "compare_url": { - "type": "string" + "triage": { + "type": "boolean" }, - "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": { + "pull": { "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" } } }, + "allow_rebase_merge": { + "type": "boolean" + }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "type": "boolean" }, "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true + "type": "boolean" }, "squash_merge_commit_title": { "type": "string", @@ -775671,20 +786140,6 @@ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, "type": "boolean" }, "subscribers_count": { @@ -775692,271 +786147,450 @@ }, "network_count": { "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] + } }, - "email": { - "type": [ - "string", - "null" - ] + "temp_clone_token": { + "type": "string" }, - "login": { - "type": "string", + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "octocat" + true ] }, - "id": { - "type": "integer", + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", "examples": [ - 1 + false ] }, - "node_id": { - "type": "string", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - "MDQ6VXNlcjE=" + false ] }, - "avatar_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", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + false ] }, - "gravatar_id": { - "type": [ - "string", - "null" + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + true ] }, - "url": { + "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", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "\"2020-07-09T00:17:42Z\"" ] }, - "html_url": { + "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" + ] + }, + "scope": { + "description": "The scope of the membership. Currently, can only be `team`.", + "type": "string", + "enum": [ + "team", + "organization" + ] + }, + "sender": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, + "events_url": { + "type": "string", + "format": "uri-template" + }, "followers_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "format": "uri" }, "following_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri-template" }, "gists_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" }, "starred_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "format": "uri-template" }, "subscriptions_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "format": "uri" }, - "organizations_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "Bot", + "User", + "Organization" ] }, - "repos_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" ] }, - "events_url": { + "html_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] }, - "type": { + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { "type": "string", - "examples": [ - "User" + "enum": [ + "open", + "closed", + "secret" ] }, - "site_admin": { - "type": "boolean" + "repositories_url": { + "type": "string", + "format": "uri" }, - "starred_at": { + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name", + "id" ] } }, "required": [ "action", - "hook_id", - "hook" + "scope", + "member", + "sender", + "team", + "organization" ] } } @@ -775970,24 +786604,25 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "membership", "supported-webhook-types": [ - "marketplace", - "business", - "repository", "organization", + "business", "app" ] } } }, - "milestone-closed": { + "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n**Note**: The pull request merge queue feature is currently in limited private beta and subject to change.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group" }, "parameters": [ { @@ -776052,104 +786687,10 @@ "content": { "application/json": { "schema": { - "title": "milestone closed event", "type": "object", "properties": { "action": { - "type": "string", - "enum": [ - "closed" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] + "type": "string" }, "installation": { "title": "Simple Installation", @@ -776176,194 +786717,117 @@ "node_id" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "merge_group": { + "title": "MergeGroup", "type": "object", "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "head_sha": { + "description": "The SHA of the merge group.", + "type": "string" }, - "closed_issues": { - "type": "integer" + "head_ref": { + "description": "The full ref of the merge group.", + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "base_sha": { + "description": "The SHA of the merge group's parent commit.", + "type": "string" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "base_ref": { + "description": "The full ref of the branch the merge group will be merged into.", + "type": "string" + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] }, "id": { - "type": "integer" - }, - "login": { "type": "string" }, - "name": { + "message": { "type": "string" }, - "node_id": { + "timestamp": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" + "tree_id": { + "type": "string" } }, "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" ] - }, - "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" + "head_sha", + "head_ref", + "base_sha", + "base_ref", + "head_commit" ] }, "organization": { @@ -778098,9 +788562,7 @@ }, "required": [ "action", - "milestone", - "repository", - "sender" + "merge_group" ] } } @@ -778114,22 +788576,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "merge-group", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "milestone-created": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -778194,13 +788654,13 @@ "content": { "application/json": { "schema": { - "title": "milestone created event", + "title": "meta deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "deleted" ] }, "enterprise": { @@ -778293,218 +788753,155 @@ "avatar_url" ] }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "hook": { + "description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.", "type": "object", "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" + "active": { + "type": "boolean" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "config": { + "type": "object", "properties": { - "avatar_url": { + "content_type": { "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "enum": [ + "json", + "form" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { + "insecure_ssl": { "type": "string" }, - "node_id": { + "secret": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "description": { - "type": [ - "string", - "null" + "content_type", + "insecure_ssl", + "url" ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "created_at": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "events": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "*", + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "create", + "delete", + "deployment", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "meta", + "milestone", + "organization", + "org_block", + "package", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "pull_request_review_thread", + "push", + "registry_package", + "release", + "repository", + "repository_import", + "repository_vulnerability_alert", + "secret_scanning_alert", + "secret_scanning_alert_location", + "security_and_analysis", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_job", + "workflow_run", + "repository_dispatch", + "projects_v2_item" + ], + "minItems": 1 + } }, "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { + "name": { "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": { "type": "string" }, "updated_at": { - "type": "string", - "format": "date-time" + "type": "string" + } + }, + "required": [ + "type", + "id", + "name", + "active", + "events", + "config", + "updated_at", + "created_at" + ] + }, + "hook_id": { + "description": "The id of the modified webhook.", + "type": "integer" + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] }, - "url": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", - "format": "uri" + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] } }, "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" ] }, "organization": { @@ -778607,104 +789004,300 @@ ] }, "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "name": { - "type": "string", - "examples": [ - "MIT License" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "pull": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "triage": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "admin", + "pull", + "push" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -778864,423 +789457,2377 @@ "type", "url" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" }, - "triage": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, - "push": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "email": { - "type": [ - "string", - "null" + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "login": { + "archive_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "id": { - "type": "integer", + "assignees_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "node_id": { + "blobs_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "avatar_url": { + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" + "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" ] - }, - "description": { + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "email": { + "type": [ + "string", + "null" ] }, - "archive_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "octocat" ] }, - "assignees_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + 1 ] }, - "blobs_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "MDQ6VXNlcjE=" ] }, - "branches_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "collaborators_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "comments_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat" ] }, - "commits_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://github.com/octocat" ] }, - "compare_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/followers" ] }, - "contents_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "contributors_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "deployments_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "downloads_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/subscriptions" ] }, - "events_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/orgs" ] }, - "forks_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/repos" ] }, - "git_refs_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "git_tags_url": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_url": { + "type": { "type": "string", "examples": [ - "git:github.com/octocat/Hello-World.git" + "User" ] }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "site_admin": { + "type": "boolean" }, - "issue_events_url": { + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "\"2020-07-09T00:17:55Z\"" ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "hook_id", + "hook" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "meta", + "supported-webhook-types": [ + "marketplace", + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-closed": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "milestone closed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" ] }, - "keys_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://github.com/enterprises/octo-business" ] }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "languages_url": { - "type": "string", - "format": "uri", + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + 42 ] }, - "merges_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "milestones_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "Octo Business" ] }, - "notifications_url": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "octo-business" ] }, - "pulls_url": { - "type": "string", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "2019-01-26T19:01:12Z" ] }, - "releases_url": { - "type": "string", + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "2019-01-26T19:14:43Z" ] }, - "ssh_url": { + "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. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "git@github.com:octocat/Hello-World.git" + 1 ] }, - "stargazers_url": { + "node_id": { + "description": "The global node ID of the installation.", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "MDQ6VXNlcjU4MzIzMQ==" ] - }, + } + }, + "required": [ + "id", + "node_id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, "statuses_url": { "type": "string", "examples": [ @@ -780264,11 +792811,11 @@ } } }, - "milestone-deleted": { + "milestone-created": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, @@ -780335,13 +792882,13 @@ "content": { "application/json": { "schema": { - "title": "milestone deleted event", + "title": "milestone created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -780561,8 +793108,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -782406,11 +794952,11 @@ } } }, - "milestone-edited": { + "milestone-deleted": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, @@ -782477,57 +795023,15 @@ "content": { "application/json": { "schema": { - "title": "milestone edited event", + "title": "milestone deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "deleted" ] }, - "changes": { - "description": "The changes to the milestone if the action was `edited`.", - "type": "object", - "properties": { - "description": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the description if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "due_on": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the due date if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - }, - "title": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the title if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -784565,7 +797069,6 @@ }, "required": [ "action", - "changes", "milestone", "repository", "sender" @@ -784591,11 +797094,11 @@ } } }, - "milestone-opened": { + "milestone-edited": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, @@ -784662,15 +797165,57 @@ "content": { "application/json": { "schema": { - "title": "milestone opened event", + "title": "milestone edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "opened" + "edited" ] }, + "changes": { + "description": "The changes to the milestone if the action was `edited`.", + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the description if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "due_on": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the due date if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -784888,7 +797433,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -786707,6 +799253,7 @@ }, "required": [ "action", + "changes", "milestone", "repository", "sender" @@ -786732,13 +799279,13 @@ } } }, - "org-block-blocked": { + "milestone-opened": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -786803,109 +799350,13 @@ "content": { "application/json": { "schema": { - "title": "org_block blocked event", + "title": "milestone opened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked" - ] - }, - "blocked_user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" + "opened" ] }, "enterprise": { @@ -787023,6 +799474,195 @@ "node_id" ] }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -788755,8 +801395,8 @@ }, "required": [ "action", - "blocked_user", - "organization", + "milestone", + "repository", "sender" ] } @@ -788771,20 +801411,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org-block", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "org-block-unblocked": { + "org-block-blocked": { "post": { "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block" }, @@ -788851,13 +801491,13 @@ "content": { "application/json": { "schema": { - "title": "org_block unblocked event", + "title": "org_block blocked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unblocked" + "blocked" ] }, "blocked_user": { @@ -790828,13 +803468,13 @@ } } }, - "organization-deleted": { + "org-block-unblocked": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block" }, "parameters": [ { @@ -790899,13 +803539,109 @@ "content": { "application/json": { "schema": { - "title": "organization deleted event", + "title": "org_block unblocked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "unblocked" + ] + }, + "blocked_user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] }, "enterprise": { @@ -791023,130 +803759,6 @@ "node_id" ] }, - "membership": { - "title": "Membership", - "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", - "type": "object", - "properties": { - "organization_url": { - "type": "string", - "format": "uri" - }, - "role": { - "type": "string" - }, - "state": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "url", - "state", - "role", - "organization_url", - "user" - ] - }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -792879,6 +805491,7 @@ }, "required": [ "action", + "blocked_user", "organization", "sender" ] @@ -792894,7 +805507,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "org-block", "supported-webhook-types": [ "organization", "business", @@ -792903,11 +805516,11 @@ } } }, - "organization-member-added": { + "organization-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, @@ -792974,13 +805587,13 @@ "content": { "application/json": { "schema": { - "title": "organization member_added event", + "title": "organization deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "member_added" + "deleted" ] }, "enterprise": { @@ -794954,7 +807567,6 @@ }, "required": [ "action", - "membership", "organization", "sender" ] @@ -794979,11 +807591,11 @@ } } }, - "organization-member-invited": { + "organization-member-added": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, @@ -795050,13 +807662,13 @@ "content": { "application/json": { "schema": { - "title": "organization member_invited event", + "title": "organization member_added event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "member_invited" + "member_added" ] }, "enterprise": { @@ -795174,41 +807786,26 @@ "node_id" ] }, - "invitation": { - "description": "The invitation for the user or email if the action is `member_invited`.", + "membership": { + "title": "Membership", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", "type": "object", "properties": { - "created_at": { + "organization_url": { "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "failed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "format": "uri" }, - "failed_reason": { - "type": [ - "string", - "null" - ] + "role": { + "type": "string" }, - "id": { - "type": "number" + "state": { + "type": "string" }, - "invitation_teams_url": { + "url": { "type": "string", "format": "uri" }, - "inviter": { + "user": { "title": "User", "type": [ "object", @@ -795303,35 +807900,14 @@ "login", "id" ] - }, - "login": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "team_count": { - "type": "number" } }, "required": [ - "id", - "node_id", - "login", - "email", + "url", + "state", "role", - "created_at", - "failed_at", - "failed_reason", - "inviter", - "team_count", - "invitation_teams_url" + "organization_url", + "user" ] }, "organization": { @@ -797062,107 +809638,11 @@ "type", "url" ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] } }, "required": [ "action", - "invitation", + "membership", "organization", "sender" ] @@ -797187,11 +809667,11 @@ } } }, - "organization-member-removed": { + "organization-member-invited": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, @@ -797258,13 +809738,13 @@ "content": { "application/json": { "schema": { - "title": "organization member_removed event", + "title": "organization member_invited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "member_removed" + "member_invited" ] }, "enterprise": { @@ -797382,26 +809862,41 @@ "node_id" ] }, - "membership": { - "title": "Membership", - "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "invitation": { + "description": "The invitation for the user or email if the action is `member_invited`.", "type": "object", "properties": { - "organization_url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "role": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "state": { - "type": "string" + "failed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "url": { + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "number" + }, + "invitation_teams_url": { "type": "string", "format": "uri" }, - "user": { + "inviter": { "title": "User", "type": [ "object", @@ -797496,14 +809991,35 @@ "login", "id" ] + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "role": { + "type": "string" + }, + "team_count": { + "type": "number" } }, "required": [ - "url", - "state", + "id", + "node_id", + "login", + "email", "role", - "organization_url", - "user" + "created_at", + "failed_at", + "failed_reason", + "inviter", + "team_count", + "invitation_teams_url" ] }, "organization": { @@ -799234,11 +811750,107 @@ "type", "url" ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] } }, "required": [ "action", - "membership", + "invitation", "organization", "sender" ] @@ -799263,11 +811875,11 @@ } } }, - "organization-renamed": { + "organization-member-removed": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, @@ -799334,28 +811946,15 @@ "content": { "application/json": { "schema": { - "title": "organization renamed event", + "title": "organization member_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "renamed" + "member_removed" ] }, - "changes": { - "type": "object", - "properties": { - "login": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -801327,6 +813926,7 @@ }, "required": [ "action", + "membership", "organization", "sender" ] @@ -801351,13 +813951,13 @@ } } }, - "package-published": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -801422,15 +814022,28 @@ "content": { "application/json": { "schema": { - "title": "package published event", + "title": "organization renamed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "published" + "renamed" ] }, + "changes": { + "type": "object", + "properties": { + "login": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", @@ -801546,138 +814159,26 @@ "node_id" ] }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "membership": { + "title": "Membership", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { + "organization_url": { "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "package": { - "description": "Information about the package.", - "type": "object", - "properties": { - "created_at": { - "type": [ - "string", - "null" - ] + "format": "uri" }, - "description": { - "type": [ - "string", - "null" - ] + "role": { + "type": "string" }, - "ecosystem": { + "state": { "type": "string" }, - "html_url": { + "url": { "type": "string", "format": "uri" }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "owner": { + "user": { "title": "User", "type": [ "object", @@ -801772,712 +814273,113 @@ "login", "id" ] + } + }, + "required": [ + "url", + "state", + "role", + "organization_url", + "user" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "package_type": { - "type": "string" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "package_version": { - "type": [ - "object", - "null" - ], - "properties": { - "author": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "body": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "body_html": { - "type": "string" - }, - "container_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "labels": { - "type": [ - "object", - "null" - ] - }, - "manifest": { - "type": [ - "object", - "null" - ] - }, - "tag": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } - }, - "created_at": { - "type": "string" - }, - "description": { - "type": "string" - }, - "docker_metadata": { - "type": "array", - "items": { - } - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "installation_command": { - "type": "string" - }, - "manifest": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - }, - "name": { - "type": "string" - }, - "npm_metadata": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - }, - "npm_user": { - "type": "string" - }, - "author": { - "type": [ - "object", - "null" - ] - }, - "bugs": { - "type": [ - "object", - "null" - ] - }, - "dependencies": { - "type": "object" - }, - "dev_dependencies": { - "type": "object" - }, - "peer_dependencies": { - "type": "object" - }, - "optional_dependencies": { - "type": "object" - }, - "description": { - "type": "string" - }, - "dist": { - "type": [ - "object", - "null" - ] - }, - "git_head": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "license": { - "type": "string" - }, - "main": { - "type": "string" - }, - "repository": { - "type": [ - "object", - "null" - ] - }, - "scripts": { - "type": "object" - }, - "id": { - "type": "string" - }, - "node_version": { - "type": "string" - }, - "npm_version": { - "type": "string" - }, - "has_shrinkwrap": { - "type": "boolean" - }, - "maintainers": { - "type": "array", - "items": { - "type": "object" - } - }, - "contributors": { - "type": "array", - "items": { - "type": "object" - } - }, - "engines": { - "type": "object" - }, - "keywords": { - "type": "array", - "items": { - "type": "string" - } - }, - "files": { - "type": "array", - "items": { - "type": "string" - } - }, - "bin": { - "type": "object" - }, - "man": { - "type": "object" - }, - "directories": { - "type": [ - "object", - "null" - ] - }, - "os": { - "type": "array", - "items": { - "type": "string" - } - }, - "cpu": { - "type": "array", - "items": { - "type": "string" - } - }, - "readme": { - "type": "string" - }, - "installation_command": { - "type": "string" - }, - "release_id": { - "type": "integer" - }, - "commit_oid": { - "type": "string" - }, - "published_via_actions": { - "type": "boolean" - }, - "deleted_by_id": { - "type": "integer" - } - } - }, - "nuget_metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "id": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - }, - "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", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "md5": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": "string" - }, - "sha1": { - "type": [ - "string", - "null" - ] - }, - "sha256": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "state": { - "type": [ - "string", - "null" - ] - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "download_url", - "id", - "name", - "sha256", - "sha1", - "md5", - "content_type", - "state", - "size", - "created_at", - "updated_at" - ] - } - }, - "package_url": { - "type": "string" - }, - "prerelease": { - "type": "boolean" - }, - "release": { - "type": "object", - "properties": { - "author": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "created_at": { - "type": "string" - }, - "draft": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "prerelease": { - "type": "boolean" - }, - "published_at": { - "type": "string" - }, - "tag_name": { - "type": "string" - }, - "target_commitish": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "id", - "tag_name", - "target_commitish", - "name", - "draft", - "author", - "prerelease", - "created_at", - "published_at" - ] - }, - "rubygems_metadata": { - "type": "array", - "items": { - } - }, - "source_url": { - "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", - "summary", - "name", - "description", - "html_url", - "metadata", - "package_files", - "installation_command" + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "registry": { - "type": [ - "object", - "null" - ], - "properties": { - "about_url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "vendor": { - "type": "string" - } - }, - "required": [ - "about_url", - "name", - "type", - "url", - "vendor" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" ] }, - "updated_at": { + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "A great organization" ] } }, "required": [ + "login", + "url", "id", - "name", - "namespace", - "description", - "ecosystem", - "package_type", - "html_url", - "created_at", - "updated_at", - "owner", - "package_version", - "registry" + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, "repository": { @@ -804113,7 +816015,7 @@ }, "required": [ "action", - "package", + "organization", "sender" ] } @@ -804128,20 +816030,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "package-updated": { + "package-published": { "post": { "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package" }, @@ -804208,13 +816110,13 @@ "content": { "application/json": { "schema": { - "title": "package updated event", + "title": "package published event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "updated" + "published" ] }, "enterprise": { @@ -804436,7 +816338,10 @@ "type": "object", "properties": { "created_at": { - "type": "string" + "type": [ + "string", + "null" + ] }, "description": { "type": [ @@ -804560,7 +816465,10 @@ "type": "string" }, "package_version": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "author": { "title": "User", @@ -804659,11 +816567,49 @@ ] }, "body": { - "type": "string" + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] }, "body_html": { "type": "string" }, + "container_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "labels": { + "type": [ + "object", + "null" + ] + }, + "manifest": { + "type": [ + "object", + "null" + ] + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, "created_at": { "type": "string" }, @@ -804694,11 +816640,219 @@ "metadata": { "type": "array", "items": { + "type": "object", + "additionalProperties": true } }, "name": { "type": "string" }, + "npm_metadata": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "type": [ + "object", + "null" + ] + }, + "bugs": { + "type": [ + "object", + "null" + ] + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "type": [ + "object", + "null" + ] + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "type": [ + "object", + "null" + ] + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "object" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "object" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "type": [ + "object", + "null" + ] + }, + "os": { + "type": "array", + "items": { + "type": "string" + } + }, + "cpu": { + "type": "array", + "items": { + "type": "string" + } + }, + "readme": { + "type": "string" + }, + "installation_command": { + "type": "string" + }, + "release_id": { + "type": "integer" + }, + "commit_oid": { + "type": "string" + }, + "published_via_actions": { + "type": "boolean" + }, + "deleted_by_id": { + "type": "integer" + } + } + }, + "nuget_metadata": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "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": { @@ -804733,13 +816887,19 @@ ] }, "sha256": { - "type": "string" + "type": [ + "string", + "null" + ] }, "size": { "type": "integer" }, "state": { - "type": "string" + "type": [ + "string", + "null" + ] }, "updated_at": { "type": "string" @@ -804879,7 +817039,10 @@ "type": "integer" }, "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, "prerelease": { "type": "boolean" @@ -804918,8 +817081,7 @@ } }, "source_url": { - "type": "string", - "format": "uri" + "type": "string" }, "summary": { "type": "string" @@ -804946,16 +817108,9 @@ "summary", "name", "description", - "body", - "body_html", "html_url", - "target_commitish", - "target_oid", - "created_at", - "updated_at", "metadata", "package_files", - "author", "installation_command" ] }, @@ -804992,7 +817147,10 @@ ] }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ] } }, "required": [ @@ -806644,7 +818802,6 @@ "required": [ "action", "package", - "repository", "sender" ] } @@ -806668,13 +818825,13 @@ } } }, - "package-v2-create": { + "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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.", - "description": "A package was created.", - "operationId": "package-v2/create", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package-v2" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -806739,12 +818896,13 @@ "content": { "application/json": { "schema": { + "title": "package updated event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "updated" ] }, "enterprise": { @@ -806962,19 +819120,24 @@ ] }, "package": { + "description": "Information about the package.", "type": "object", "properties": { "created_at": { "type": "string" }, "description": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ecosystem": { "type": "string" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" @@ -806985,190 +819148,535 @@ "namespace": { "type": "string" }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "package_type": { + "type": "string" + }, "package_version": { "type": "object", "properties": { - "blob_store": { + "author": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "body": { "type": "string" }, - "container_metadata": { + "body_html": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "sha1": { + "type": [ + "string", + "null" + ] + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "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": { - "labels": { - "type": "object", + "author": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "all_labels": { - "type": "object", - "properties": { - "com.github.base_image.id": { - "type": "string" - }, - "com.github.base_image.repo_digest": { - "type": "string" - }, - "com.github.repo.branch": { - "type": "string" - }, - "ghes.licenses.path": { - "type": "string" - }, - "org.opencontainers.image.created": { - "type": "string" - }, - "org.opencontainers.image.description": { - "type": "string" - }, - "org.opencontainers.image.documentation": { - "type": "string" - }, - "org.opencontainers.image.revision": { - "type": "string" - }, - "org.opencontainers.image.source": { - "type": "string" - } - } - }, - "description": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri" }, - "image_url": { - "type": "string" + "deleted": { + "type": "boolean" }, - "licenses": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "revision": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri-template" }, - "source": { - "type": "string" - } - }, - "required": [ - "description", - "source", - "revision", - "image_url", - "licenses", - "all_labels" - ] - }, - "manifest": { - "type": "object", - "properties": { - "config": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "media_type": { - "type": "string" - }, - "size": { - "type": "integer" - } - }, - "required": [ - "digest", - "media_type", - "size" - ] + "followers_url": { + "type": "string", + "format": "uri" }, - "digest": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "layers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "media_type": { - "type": "string" - }, - "size": { - "type": "integer" - } - }, - "required": [ - "digest", - "media_type", - "size" - ] - } + "gists_url": { + "type": "string", + "format": "uri-template" }, - "media_type": { + "gravatar_id": { "type": "string" }, - "size": { + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "uri": { - "type": "string" - } - }, - "required": [ - "digest", - "media_type", - "uri", - "size", - "config", - "layers" - ] - }, - "tag": { - "type": "object", - "properties": { - "digest": { + "login": { "type": "string" }, "name": { "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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": [ - "name", - "digest" + "login", + "id" ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "tag", - "labels", - "manifest" + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" ] }, - "created_at": { - "type": "string" + "rubygems_metadata": { + "type": "array", + "items": { + } }, - "description": { + "source_url": { + "type": "string", + "format": "uri" + }, + "summary": { "type": "string" }, - "html_url": { + "tag_name": { "type": "string" }, - "id": { - "type": "integer" + "target_commitish": { + "type": "string" }, - "name": { + "target_oid": { "type": "string" }, "updated_at": { "type": "string" + }, + "version": { + "type": "string" } }, "required": [ "id", + "version", + "summary", "name", "description", - "blob_store", + "body", + "body_html", "html_url", + "target_commitish", + "target_oid", "created_at", - "updated_at" + "updated_at", + "metadata", + "package_files", + "author", + "installation_command" + ] + }, + "registry": { + "type": [ + "object", + "null" + ], + "properties": { + "about_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "vendor": { + "type": "string" + } + }, + "required": [ + "about_url", + "name", + "type", + "url", + "vendor" ] }, "updated_at": { @@ -807181,10 +819689,13 @@ "namespace", "description", "ecosystem", + "package_type", "html_url", "created_at", "updated_at", - "package_version" + "owner", + "package_version", + "registry" ] }, "repository": { @@ -808821,7 +821332,7 @@ "required": [ "action", "package", - "organization", + "repository", "sender" ] } @@ -808836,7 +821347,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package-v2", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -808845,12 +821356,13 @@ } } }, - "page-build": { + "package-v2-create": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.", + "description": "A package was created.", + "operationId": "package-v2/create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#page-build" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package-v2" }, "parameters": [ { @@ -808915,155 +821427,12 @@ "content": { "application/json": { "schema": { - "title": "page_build event", "type": "object", "properties": { - "build": { - "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-github-pages-builds) itself.", - "type": "object", - "properties": { - "commit": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "duration": { - "type": "integer" - }, - "error": { - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "message" - ] - }, - "pusher": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "status": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "status", - "error", - "pusher", - "commit", - "duration", - "created_at", - "updated_at" + "action": { + "type": "string", + "enum": [ + "create" ] }, "enterprise": { @@ -809156,9 +821525,6 @@ "avatar_url" ] }, - "id": { - "type": "integer" - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -809283,6 +821649,232 @@ "description" ] }, + "package": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "package_version": { + "type": "object", + "properties": { + "blob_store": { + "type": "string" + }, + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": "object", + "properties": { + "all_labels": { + "type": "object", + "properties": { + "com.github.base_image.id": { + "type": "string" + }, + "com.github.base_image.repo_digest": { + "type": "string" + }, + "com.github.repo.branch": { + "type": "string" + }, + "ghes.licenses.path": { + "type": "string" + }, + "org.opencontainers.image.created": { + "type": "string" + }, + "org.opencontainers.image.description": { + "type": "string" + }, + "org.opencontainers.image.documentation": { + "type": "string" + }, + "org.opencontainers.image.revision": { + "type": "string" + }, + "org.opencontainers.image.source": { + "type": "string" + } + } + }, + "description": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "licenses": { + "type": "string" + }, + "revision": { + "type": "string" + }, + "source": { + "type": "string" + } + }, + "required": [ + "description", + "source", + "revision", + "image_url", + "licenses", + "all_labels" + ] + }, + "manifest": { + "type": "object", + "properties": { + "config": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "media_type": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "required": [ + "digest", + "media_type", + "size" + ] + }, + "digest": { + "type": "string" + }, + "layers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "media_type": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "required": [ + "digest", + "media_type", + "size" + ] + } + }, + "media_type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "uri": { + "type": "string" + } + }, + "required": [ + "digest", + "media_type", + "uri", + "size", + "config", + "layers" + ] + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "name", + "digest" + ] + } + }, + "required": [ + "tag", + "labels", + "manifest" + ] + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "description", + "blob_store", + "html_url", + "created_at", + "updated_at" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "html_url", + "created_at", + "updated_at", + "package_version" + ] + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -810915,9 +823507,9 @@ } }, "required": [ - "id", - "build", - "repository", + "action", + "package", + "organization", "sender" ] } @@ -810932,7 +823524,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page-build", + "subcategory": "package-v2", "supported-webhook-types": [ "repository", "organization", @@ -810941,12 +823533,12 @@ } } }, - "ping": { + "page-build": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#page-build" }, "parameters": [ { @@ -811011,152 +823603,275 @@ "content": { "application/json": { "schema": { + "title": "page_build event", "type": "object", "properties": { - "hook": { - "title": "Webhook", - "description": "The webhook that is being pinged", + "build": { + "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-github-pages-builds) itself.", "type": "object", "properties": { - "active": { - "description": "Determines whether the hook is actually triggered for the events it subscribes to.", - "type": "boolean" + "commit": { + "type": [ + "string", + "null" + ] }, - "app_id": { - "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.", + "created_at": { + "type": "string" + }, + "duration": { "type": "integer" }, - "config": { + "error": { "type": "object", "properties": { - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" + "message": { + "type": [ + "string", + "null" ] + } + }, + "required": [ + "message" + ] + }, + "pusher": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" ] }, - "secret": { + "events_url": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] + "format": "uri" } - } + }, + "required": [ + "login", + "id" + ] }, - "created_at": { - "type": "string", - "format": "date-time" + "status": { + "type": "string" }, - "deliveries_url": { + "updated_at": { + "type": "string" + }, + "url": { "type": "string", "format": "uri" + } + }, + "required": [ + "url", + "status", + "error", + "pusher", + "commit", + "duration", + "created_at", + "updated_at" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 ] }, - "name": { - "description": "The type of webhook. The only valid value is 'web'.", + "node_id": { "type": "string", - "enum": [ - "web" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "ping_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri" + "examples": [ + "Octo Business" + ] }, - "test_url": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", - "format": "uri" + "examples": [ + "octo-business" + ] }, - "type": { - "type": "string" + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] }, "updated_at": { - "type": "string", - "format": "date-time" + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] }, - "url": { + "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", - "type", + "node_id", "name", - "active", - "events", - "config", + "slug", + "html_url", "created_at", - "updated_at" + "updated_at", + "avatar_url" ] }, - "hook_id": { - "description": "The ID of the webhook that triggered the ping.", + "id": { "type": "integer" }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -812885,180 +825600,14 @@ "type", "url" ] - }, - "zen": { - "description": "Random string of GitHub zen.", - "type": "string" - } - } - }, - "examples": { - "default": { - "value": { - "zen": "Anything added dilutes everything else.", - "hook_id": 109948940, - "hook": { - "type": "Repository", - "id": 109948940, - "name": "web", - "active": true, - "events": [ - "*" - ], - "config": { - "content_type": "json", - "url": "https://smee.io/****************", - "insecure_ssl": "0" - }, - "updated_at": "2019-05-15T15:20:49Z", - "created_at": "2019-05-15T15:20:49Z", - "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940", - "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test", - "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - }, - "repository": { - "id": 186853261, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", - "name": "Hello-World", - "full_name": "Octocoders/Hello-World", - "private": false, - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/Octocoders/Hello-World", - "description": null, - "fork": true, - "url": "https://api.github.com/repos/Octocoders/Hello-World", - "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", - "created_at": "2019-05-15T15:20:42Z", - "updated_at": "2019-05-15T15:20:45Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Octocoders/Hello-World.git", - "ssh_url": "git@github.com:Octocoders/Hello-World.git", - "clone_url": "https://github.com/Octocoders/Hello-World.git", - "svn_url": "https://github.com/Octocoders/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": false, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "description": "The webhooks ping payload encoded with URL encoding.", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object.", - "type": "string" } }, "required": [ - "payload" + "id", + "build", + "repository", + "sender" ] - }, - "examples": { - "default": { - "value": { - "payload": "%7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D" - } - } } } } @@ -813070,26 +825619,22 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "page-build", "supported-webhook-types": [ "repository", "organization", - "app", - "business", - "marketplace" + "app" ] } } }, - "project-card-converted": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a classic project was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -813154,148 +825699,151 @@ "content": { "application/json": { "schema": { - "title": "project_card converted event", "type": "object", "properties": { - "action": { - "type": "string", - "enum": [ - "converted" - ] - }, - "changes": { + "hook": { + "title": "Webhook", + "description": "The webhook that is being pinged", "type": "object", "properties": { - "note": { + "active": { + "description": "Determines whether the hook is actually triggered for the events it subscribes to.", + "type": "boolean" + }, + "app_id": { + "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.", + "type": "integer" + }, + "config": { "type": "object", "properties": { - "from": { - "type": "string" + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "note" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] + } }, - "html_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] + "format": "date-time" }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], + "deliveries_url": { + "type": "string", "format": "uri" }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + } + }, "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] + "description": "Unique identifier of the webhook.", + "type": "integer" }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "code", + "status", + "message" ] }, "name": { - "description": "The name of the enterprise.", + "description": "The type of webhook. The only valid value is 'web'.", "type": "string", - "examples": [ - "Octo Business" + "enum": [ + "web" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "ping_url": { "type": "string", - "examples": [ - "octo-business" - ] + "format": "uri" }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] + "test_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" }, "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "type": "string", + "format": "date-time" }, - "avatar_url": { + "url": { "type": "string", "format": "uri" } }, "required": [ "id", - "node_id", + "type", "name", - "slug", - "html_url", + "active", + "events", + "config", "created_at", - "updated_at", - "avatar_url" + "updated_at" ] }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] + "hook_id": { + "description": "The ID of the webhook that triggered the ping.", + "type": "integer" }, "organization": { "title": "Organization Simple", @@ -813396,171 +825944,6 @@ "description" ] }, - "project_card": { - "title": "Project Card", - "type": "object", - "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_id": { - "type": "integer" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "column_url", - "column_id", - "id", - "node_id", - "note", - "archived", - "creator", - "created_at", - "updated_at" - ] - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -815190,14 +827573,180 @@ "type", "url" ] + }, + "zen": { + "description": "Random string of GitHub zen.", + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "zen": "Anything added dilutes everything else.", + "hook_id": 109948940, + "hook": { + "type": "Repository", + "id": 109948940, + "name": "web", + "active": true, + "events": [ + "*" + ], + "config": { + "content_type": "json", + "url": "https://smee.io/****************", + "insecure_ssl": "0" + }, + "updated_at": "2019-05-15T15:20:49Z", + "created_at": "2019-05-15T15:20:49Z", + "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940", + "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test", + "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + }, + "repository": { + "id": 186853261, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", + "name": "Hello-World", + "full_name": "Octocoders/Hello-World", + "private": false, + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "html_url": "https://github.com/Octocoders/Hello-World", + "description": null, + "fork": true, + "url": "https://api.github.com/repos/Octocoders/Hello-World", + "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T15:20:42Z", + "updated_at": "2019-05-15T15:20:45Z", + "pushed_at": "2019-05-15T15:20:33Z", + "git_url": "git://github.com/Octocoders/Hello-World.git", + "ssh_url": "git@github.com:Octocoders/Hello-World.git", + "clone_url": "https://github.com/Octocoders/Hello-World.git", + "svn_url": "https://github.com/Octocoders/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": false, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 0, + "license": null, + "forks": 0, + "open_issues": 0, + "watchers": 0, + "default_branch": "master" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "description": "The webhooks ping payload encoded with URL encoding.", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object.", + "type": "string" } }, "required": [ - "action", - "changes", - "project_card", - "sender" + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D" + } + } } } } @@ -815209,21 +827758,24 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project-card", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "project-card-created": { + "project-card-converted": { "post": { "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a classic project.", - "operationId": "project-card/created", + "description": "A note in a classic project was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, @@ -815290,13 +827842,32 @@ "content": { "application/json": { "schema": { - "title": "project_card created event", + "title": "project_card converted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "converted" + ] + }, + "changes": { + "type": "object", + "properties": { + "note": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "note" ] }, "enterprise": { @@ -817311,6 +829882,7 @@ }, "required": [ "action", + "changes", "project_card", "sender" ] @@ -817335,11 +829907,11 @@ } } }, - "project-card-deleted": { + "project-card-created": { "post": { "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a classic project was deleted.", - "operationId": "project-card/deleted", + "description": "A card was added to a classic project.", + "operationId": "project-card/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, @@ -817406,13 +829978,13 @@ "content": { "application/json": { "schema": { - "title": "project_card deleted event", + "title": "project_card created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -817644,10 +830216,7 @@ "type": "boolean" }, "column_id": { - "type": [ - "integer", - "null" - ] + "type": "integer" }, "column_url": { "type": "string", @@ -817744,8 +830313,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -817799,2249 +830367,104 @@ ] }, "repository": { - "anyOf": [ - { - "type": "null" + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name": { + "type": "string", + "examples": [ + "MIT License" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "triage": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "push": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "maintain": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "project_card", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "project-card", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "project-card-edited": { - "post": { - "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a classic project was edited.", - "operationId": "project-card/edited", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "project_card edited event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" - ] - }, - "changes": { - "type": "object", - "properties": { - "note": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "note" - ] - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "project_card": { - "title": "Project Card", - "type": "object", - "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean" - }, - "column_id": { - "type": "integer" - }, - "column_url": { - "type": "string", - "format": "uri" - }, - "content_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "column_url", - "column_id", - "id", - "node_id", - "note", - "archived", - "creator", - "created_at", - "updated_at" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -821576,7 +831999,6 @@ }, "required": [ "action", - "changes", "project_card", "sender" ] @@ -821601,11 +832023,11 @@ } } }, - "project-card-moved": { + "project-card-deleted": { "post": { "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a classic project was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "description": "A card on a classic project was deleted.", + "operationId": "project-card/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, @@ -821672,32 +832094,13 @@ "content": { "application/json": { "schema": { - "title": "project_card moved event", + "title": "project_card deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "moved" - ] - }, - "changes": { - "type": "object", - "properties": { - "column_id": { - "type": "object", - "properties": { - "from": { - "type": "integer" - } - }, - "required": [ - "from" - ] - } - }, - "required": [ - "column_id" + "deleted" ] }, "enterprise": { @@ -821915,383 +832318,469 @@ ] }, "project_card": { - "allOf": [ - { - "title": "Project Card", - "type": "object", + "title": "Project Card", + "type": "object", + "properties": { + "after_id": { + "type": [ + "integer", + "null" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": [ + "integer", + "null" + ] + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" }, - "archived": { - "description": "Whether or not the card is archived", + "deleted": { "type": "boolean" }, - "column_id": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] }, - "column_url": { + "events_url": { "type": "string", - "format": "uri" + "format": "uri-template" }, - "content_url": { + "followers_url": { "type": "string", "format": "uri" }, - "created_at": { + "following_url": { "type": "string", - "format": "date-time" + "format": "uri-template" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" }, "id": { - "description": "The project card's ID", "type": "integer" }, - "node_id": { + "login": { "type": "string" }, - "note": { - "type": [ - "string", - "null" - ] + "name": { + "type": "string" }, - "project_url": { + "node_id": { + "type": "string" + }, + "organizations_url": { "type": "string", "format": "uri" }, - "updated_at": { + "received_events_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "url": { + "repos_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "column_url", - "column_id", - "id", - "node_id", - "note", - "archived", - "creator", - "created_at", - "updated_at" - ] - }, - { - "type": "object", - "properties": { - "after_id": { - "type": [ - "number", - "null" - ] }, - "archived": { + "site_admin": { "type": "boolean" }, - "column_id": { - "type": "integer" - }, - "column_url": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "creator": { - "type": [ - "object", - "null" - ], - "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" - } - } - }, - "id": { - "type": "integer" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "node_id": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "note": { - "type": [ - "string", - "null" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" ] }, - "project_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, "url": { - "type": "string" + "type": "string", + "format": "uri" } }, "required": [ - "after_id" + "login", + "id" ] - } - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { + }, "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] + "description": "The project card's ID", + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "type": "string" + }, + "note": { + "type": [ + "string", + "null" ] }, - "name": { - "description": "The name of the repository.", + "project_url": { "type": "string", - "examples": [ - "Team Environment" - ] + "format": "uri" }, - "full_name": { + "updated_at": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "format": "date-time" }, - "license": { - "anyOf": [ - { - "type": "null" + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "name": { - "type": "string", - "examples": [ - "MIT License" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "pull": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "triage": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "admin", + "pull", + "push" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -822451,411 +832940,2360 @@ "type", "url" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" }, - "triage": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, - "push": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "email": { - "type": [ - "string", - "null" + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "login": { + "archive_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "id": { - "type": "integer", + "assignees_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "node_id": { + "blobs_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "avatar_url": { + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "description": { + "email": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" - }, - "url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "octocat" ] }, - "archive_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + 1 ] }, - "assignees_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "MDQ6VXNlcjE=" ] }, - "blobs_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "branches_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "collaborators_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/users/octocat" ] }, - "comments_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://github.com/octocat" ] }, - "commits_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/followers" ] }, - "compare_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "contents_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contributors_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "deployments_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/subscriptions" ] }, - "downloads_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/orgs" ] }, - "events_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/repos" ] }, - "forks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "git_commits_url": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_refs_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "User" ] }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "site_admin": { + "type": "boolean" }, - "git_url": { + "starred_at": { "type": "string", "examples": [ - "git:github.com/octocat/Hello-World.git" + "\"2020-07-09T00:17:55Z\"" ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "project_card", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project-card", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-card-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a classic project was edited.", + "operationId": "project-card/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "project_card edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "note": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "from" ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + } + }, + "required": [ + "note" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" ] }, - "issues_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "https://github.com/enterprises/octo-business" ] }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "labels_url": { - "type": "string", + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 42 ] }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "merges_url": { + "name": { + "description": "The name of the enterprise.", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "Octo Business" ] }, - "milestones_url": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "octo-business" ] }, - "notifications_url": { - "type": "string", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "2019-01-26T19:01:12Z" ] }, - "pulls_url": { - "type": "string", + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "2019-01-26T19:14:43Z" ] }, - "releases_url": { + "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. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + 1 ] }, - "ssh_url": { + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "project_card": { + "title": "Project Card", + "type": "object", + "properties": { + "after_id": { + "type": [ + "integer", + "null" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": "integer" + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": [ + "string", + "null" + ] + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { "type": "string", "examples": [ "git@github.com:octocat/Hello-World.git" @@ -823826,6 +836264,7 @@ }, "required": [ "action", + "changes", "project_card", "sender" ] @@ -823850,13 +836289,13 @@ } } }, - "project-closed": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a classic project was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card" }, "parameters": [ { @@ -823921,13 +836360,32 @@ "content": { "application/json": { "schema": { - "title": "project closed event", + "title": "project_card moved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed" + "moved" + ] + }, + "changes": { + "type": "object", + "properties": { + "column_id": { + "type": "object", + "properties": { + "from": { + "type": "integer" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "column_id" ] }, "enterprise": { @@ -824144,173 +836602,283 @@ "description" ] }, - "project": { - "title": "Project", - "type": "object", - "properties": { - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], + "project_card": { + "allOf": [ + { + "title": "Project Card", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "after_id": { "type": [ - "string", + "integer", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" }, - "followers_url": { + "column_id": { + "type": "integer" + }, + "column_url": { "type": "string", "format": "uri" }, - "following_url": { + "content_url": { "type": "string", - "format": "uri-template" + "format": "uri" }, - "gists_url": { + "created_at": { "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" + "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri" + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, "id": { + "description": "The project card's ID", "type": "integer" }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, - "organizations_url": { + "note": { + "type": [ + "string", + "null" + ] + }, + "project_url": { "type": "string", "format": "uri" }, - "received_events_url": { + "updated_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "repos_url": { + "url": { "type": "string", "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + { + "type": "object", + "properties": { + "after_id": { + "type": [ + "number", + "null" + ] }, - "site_admin": { + "archived": { "type": "boolean" }, - "starred_url": { - "type": "string", - "format": "uri-template" + "column_id": { + "type": "integer" }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "column_url": { + "type": "string" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + "created_at": { + "type": "string" + }, + "creator": { + "type": [ + "object", + "null" + ], + "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" + } + } + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": [ + "string", + "null" ] }, + "project_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, "url": { - "type": "string", - "format": "uri" + "type": "string" } }, "required": [ - "login", - "id" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "owner_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" + "after_id" ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at" ] }, "repository": { @@ -825946,7 +838514,7 @@ }, "required": [ "action", - "project", + "project_card", "sender" ] } @@ -825961,7 +838529,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project-card", "supported-webhook-types": [ "repository", "organization", @@ -825970,13 +838538,13 @@ } } }, - "project-column-created": { + "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a classic project.", - "operationId": "project-column/created", + "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A classic project was closed.", + "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -826041,13 +838609,13 @@ "content": { "application/json": { "schema": { - "title": "project_column created event", + "title": "project closed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "closed" ] }, "enterprise": { @@ -826264,17 +838832,18 @@ "description" ] }, - "project_column": { - "title": "Project Column", + "project": { + "title": "Project", "type": "object", "properties": { - "after_id": { + "body": { + "description": "Body of the project", "type": [ - "integer", + "string", "null" ] }, - "cards_url": { + "columns_url": { "type": "string", "format": "uri" }, @@ -826282,21 +838851,131 @@ "type": "string", "format": "date-time" }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { - "description": "The unique identifier of the project column", "type": "integer" }, "name": { - "description": "Name of the project column", + "description": "Name of the project", "type": "string" }, "node_id": { "type": "string" }, - "project_url": { + "number": { + "type": "integer" + }, + "owner_url": { "type": "string", "format": "uri" }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, "updated_at": { "type": "string", "format": "date-time" @@ -826307,12 +838986,17 @@ } }, "required": [ + "owner_url", "url", - "project_url", - "cards_url", + "html_url", + "columns_url", "id", "node_id", "name", + "body", + "number", + "state", + "creator", "created_at", "updated_at" ] @@ -827950,7 +840634,8 @@ }, "required": [ "action", - "project_column" + "project", + "sender" ] } } @@ -827964,7 +840649,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project-column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -827973,11 +840658,11 @@ } } }, - "project-column-deleted": { + "project-column-created": { "post": { "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a classic project.", - "operationId": "project-column/deleted", + "description": "A column was added to a classic project.", + "operationId": "project-column/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" }, @@ -828044,13 +840729,13 @@ "content": { "application/json": { "schema": { - "title": "project_column deleted event", + "title": "project_column created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -828321,2130 +841006,104 @@ ] }, "repository": { - "anyOf": [ - { - "type": "null" + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name": { + "type": "string", + "examples": [ + "MIT License" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "triage": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "push": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "maintain": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "project_column" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "project-column", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "project-column-edited": { - "post": { - "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a classic project was changed.", - "operationId": "project-column/edited", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "project_column edited event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" - ] - }, - "changes": { - "type": "object", - "properties": { - "name": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "project_column": { - "title": "Project Column", - "type": "object", - "properties": { - "after_id": { - "type": [ - "integer", - "null" - ] - }, - "cards_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer" - }, - "name": { - "description": "Name of the project column", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "project_url", - "cards_url", - "id", - "node_id", - "name", - "created_at", - "updated_at" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -831979,7 +842638,6 @@ }, "required": [ "action", - "changes", "project_column" ] } @@ -832003,11 +842661,11 @@ } } }, - "project-column-moved": { + "project-column-deleted": { "post": { "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a classic project.", - "operationId": "project-column/moved", + "description": "A column was deleted from a classic project.", + "operationId": "project-column/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" }, @@ -832074,13 +842732,13 @@ "content": { "application/json": { "schema": { - "title": "project_column moved event", + "title": "project_column deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "moved" + "deleted" ] }, "enterprise": { @@ -832351,127 +843009,2153 @@ ] }, "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] - }, - "html_url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "organization": { + "anyOf": [ + { + "type": "null" }, - "id": { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "project_column" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project-column", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-column-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a classic project was changed.", + "operationId": "project-column/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "project_column edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "project_column": { + "title": "Project Column", + "type": "object", + "properties": { + "after_id": { + "type": [ + "integer", + "null" + ] + }, + "cards_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer" + }, + "name": { + "description": "Name of the project column", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "cards_url", + "id", + "node_id", + "name", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { "type": "integer", "examples": [ 1 @@ -833983,9 +846667,9 @@ }, "required": [ "action", - "project_column", - "sender" - ] + "changes", + "project_column" + ] } } } @@ -834007,13 +846691,13 @@ } } }, - "project-created": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a classic project.", + "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column" }, "parameters": [ { @@ -834078,13 +846762,13 @@ "content": { "application/json": { "schema": { - "title": "project created event", + "title": "project_column moved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "moved" ] }, "enterprise": { @@ -834301,18 +846985,17 @@ "description" ] }, - "project": { - "title": "Project", + "project_column": { + "title": "Project Column", "type": "object", "properties": { - "body": { - "description": "Body of the project", + "after_id": { "type": [ - "string", + "integer", "null" ] }, - "columns_url": { + "cards_url": { "type": "string", "format": "uri" }, @@ -834320,131 +847003,21 @@ "type": "string", "format": "date-time" }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, "id": { + "description": "The unique identifier of the project column", "type": "integer" }, "name": { - "description": "Name of the project", + "description": "Name of the project column", "type": "string" }, "node_id": { "type": "string" }, - "number": { - "type": "integer" - }, - "owner_url": { + "project_url": { "type": "string", "format": "uri" }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, "updated_at": { "type": "string", "format": "date-time" @@ -834455,17 +847028,12 @@ } }, "required": [ - "owner_url", "url", - "html_url", - "columns_url", + "project_url", + "cards_url", "id", "node_id", "name", - "body", - "number", - "state", - "creator", "created_at", "updated_at" ] @@ -836103,7 +848671,7 @@ }, "required": [ "action", - "project", + "project_column", "sender" ] } @@ -836118,7 +848686,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project-column", "supported-webhook-types": [ "repository", "organization", @@ -836127,11 +848695,11 @@ } } }, - "project-deleted": { + "project-created": { "post": { "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was deleted.", - "operationId": "project/deleted", + "description": "A classic project was created.", + "operationId": "project/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, @@ -836198,13 +848766,13 @@ "content": { "application/json": { "schema": { - "title": "project deleted event", + "title": "project created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "created" ] }, "enterprise": { @@ -836591,2260 +849159,104 @@ ] }, "repository": { - "anyOf": [ - { - "type": "null" + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name": { + "type": "string", + "examples": [ + "MIT License" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "pull": { - "type": "boolean" + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "triage": { - "type": "boolean" + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "push": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "maintain": { - "type": "boolean" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "admin", - "pull", - "push" + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "project" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "project", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "project-edited": { - "post": { - "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a classic project was changed.", - "operationId": "project/edited", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "project edited event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "edited" - ] - }, - "changes": { - "description": "The changes to the project if the action was `edited`.", - "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 changes to the project if the action was `edited`.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "project": { - "title": "Project", - "type": "object", - "properties": { - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ] - }, - "columns_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "name": { - "description": "Name of the project", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "owner_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -840379,7 +850791,8 @@ }, "required": [ "action", - "project" + "project", + "sender" ] } } @@ -840402,11 +850815,11 @@ } } }, - "project-reopened": { + "project-deleted": { "post": { "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A classic project was closed.", - "operationId": "project/reopened", + "description": "A classic project was deleted.", + "operationId": "project/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, @@ -840473,13 +850886,13 @@ "content": { "application/json": { "schema": { - "title": "project reopened event", + "title": "project deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "deleted" ] }, "enterprise": { @@ -840866,104 +851279,300 @@ ] }, "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "anyOf": [ + { + "type": "null" }, - "license": { - "anyOf": [ - { - "type": "null" + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri" + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "admin", + "pull", + "push" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -841123,897 +851732,363 @@ "type", "url" ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" }, - "push": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "email": { + "description": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", + ], "examples": [ - "octocat" + "This your first repo!" ] }, - "id": { - "type": "integer", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", "examples": [ - 1 + "https://api.github.com/repos/octocat/Hello-World" ] }, - "node_id": { + "archive_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "avatar_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "blobs_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "url": { + "branches_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "html_url": { + "collaborators_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "followers_url": { + "comments_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "following_url": { + "commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "gists_url": { + "compare_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "starred_url": { + "contents_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "subscriptions_url": { + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "type": { + "git_commits_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "git_refs_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" }, "git_tags_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] }, "issue_events_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] }, "issues_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] }, "keys_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] }, "labels_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] }, "languages_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] }, "merges_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] }, "milestones_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, "notifications_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, "pulls_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, "releases_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] }, "statuses_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] }, "subscribers_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] }, "subscription_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] }, "tags_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, "teams_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] }, "trees_url": { - "type": "string" + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] }, "hooks_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] }, "language": { - "type": "string" + "type": [ + "string", + "null" + ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { - "type": "integer" + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 0 + ] }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -842022,78 +852097,507 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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" + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, "created_at": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] }, "updated_at": { - "type": "string" + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] }, - "permissions": { - "type": "object", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], "properties": { - "admin": { + "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" }, - "maintain": { + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { "type": "boolean" }, - "push": { + "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" }, - "triage": { + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { "type": "boolean" }, - "pull": { + "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" } } }, - "allow_rebase_merge": { - "type": "boolean" - }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { - "type": "boolean" + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "allow_auto_merge": { - "type": "boolean" + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, "allow_update_branch": { - "type": "boolean" + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, "use_squash_pr_title_as_default": { - "type": "boolean" + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -842130,6 +852634,20 @@ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, "subscribers_count": { @@ -842137,201 +852655,103 @@ }, "network_count": { "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + }, + "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" ] - }, - "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": { @@ -842498,8 +852918,7 @@ }, "required": [ "action", - "project", - "sender" + "project" ] } } @@ -842522,13 +852941,13 @@ } } }, - "projects-v2-item-archived": { + "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a classic project was changed.", + "operationId": "project/edited", "externalDocs": { - "url": "" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -842550,7 +852969,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -842593,39 +853012,135 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Archived Event", + "title": "project edited event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "archived" + "edited" ] }, "changes": { + "description": "The changes to the project if the action was `edited`.", "type": "object", "properties": { - "archived_at": { + "body": { "type": "object", "properties": { "from": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "to": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "description": "The previous version of the body if the action was `edited`.", + "type": "string" } - } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The changes to the project if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -842750,34 +853265,465 @@ "description" ] }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", + "project": { + "title": "Project", "type": "object", "properties": { + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ] + }, + "columns_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, "id": { - "type": "number" + "type": "integer" }, - "node_id": { + "name": { + "description": "Name of the project", "type": "string" }, - "project_node_id": { + "node_id": { "type": "string" }, - "content_node_id": { - "type": "string" + "number": { + "type": "integer" }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "owner_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", "type": "string", "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "open", + "closed" ] }, - "creator": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -842938,672 +853884,1023 @@ "url" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/octocat/Hello-World" ] }, - "archived_at": { + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-04-28T12:00:00Z" + "This your first repo!" ] - } - }, - "required": [ - "id", - "content_node_id", - "content_type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "email": { - "type": [ - "string", - "null" + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "login": { + "assignees_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "id": { - "type": "integer", + "blobs_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "node_id": { + "branches_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "avatar_url": { + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "git:github.com/octocat/Hello-World.git" ] }, - "organizations_url": { + "issue_comment_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "repos_url": { + "issue_events_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "events_url": { + "issues_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "received_events_url": { + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "type": { + "merges_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "site_admin": { - "type": "boolean" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "starred_at": { + "notifications_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "projects_v2_item", - "organization", - "sender", - "changes" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "webhooks", - "subcategory": "projects_v2_item", - "supported-webhook-types": [ - "organization" - ] - } - } - }, - "projects-v2-item-converted": { - "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", - "externalDocs": { - "url": "" - }, - "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": "project-v2-item", - "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": "Projects v2 Item Converted Event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "converted" - ] - }, - "changes": { - "type": "object", - "properties": { - "content_type": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - }, - "to": { - "type": "string" - } - } - } - } - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", + }, + "pulls_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "node_id": { - "description": "The global node ID of the installation.", + "releases_url": { "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] - } - }, - "required": [ - "id", - "node_id" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { + }, + "ssh_url": { "type": "string", "examples": [ - "github" + "git@github.com:octocat/Hello-World.git" ] }, - "id": { - "type": "integer", + "stargazers_url": { + "type": "string", + "format": "uri", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "node_id": { + "statuses_url": { "type": "string", "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "repos_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/repos" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "events_url": { + "tags_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/orgs/github/events" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "hooks_url": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/hooks" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "issues_url": { + "trees_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/issues" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "members_url": { + "clone_url": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "https://github.com/octocat/Hello-World.git" ] }, - "public_members_url": { + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "avatar_url": { + "svn_url": { "type": "string", + "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://svn.github.com/octocat/Hello-World" ] }, - "description": { + "homepage": { "type": [ "string", "null" ], + "format": "uri", "examples": [ - "A great organization" + "https://github.com" ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", - "type": "object", - "properties": { - "id": { - "type": "number" }, - "node_id": { - "type": "string" + "language": { + "type": [ + "string", + "null" + ] }, - "project_node_id": { - "type": "string" + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] }, - "content_node_id": { - "type": "string" + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "examples": [ + "master" ] }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, "name": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "full_name": { + "type": "string" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "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" + } + } }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "private": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "html_url": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "description": { + "type": "string" }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "fork": { + "type": "boolean" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "archive_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "assignees_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "blobs_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "branches_url": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "collaborators_url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "comments_url": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "commits_url": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "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", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "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)." }, - "received_events_url": { + "squash_merge_commit_message": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "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." }, - "type": { + "merge_commit_title": { "type": "string", - "examples": [ - "User" - ] + "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)." }, - "site_admin": { + "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" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "created_at": { - "type": "string", - "format": "date-time", + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + false ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + false ] }, - "archived_at": { - "type": [ - "string", - "null" + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" ], - "format": "date-time", + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "2022-04-28T12:00:00Z" + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", - "content_node_id", - "content_type", + "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", - "archived_at" + "updated_at" ] }, "sender": { @@ -843770,10 +855067,7 @@ }, "required": [ "action", - "projects_v2_item", - "organization", - "sender", - "changes" + "project" ] } } @@ -843786,22 +855080,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-created": { + "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "summary": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A classic project was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "" + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -843823,7 +855118,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -843866,13 +855161,103 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Created Event", + "title": "project reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "reopened" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, "installation": { @@ -843999,43 +855384,38 @@ "description" ] }, - "projects_v2_item": { - "title": "Projects v2 Item", - "description": "An item belonging to a project", + "project": { + "title": "Project", "type": "object", "properties": { - "id": { - "type": "number" - }, - "node_id": { - "type": "string" - }, - "project_node_id": { - "type": "string" + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ] }, - "content_node_id": { - "type": "string" + "columns_url": { + "type": "string", + "format": "uri" }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", + "created_at": { "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] + "format": "date-time" }, "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "title": "User", + "type": [ + "object", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" }, "email": { "type": [ @@ -844043,23 +855423,459 @@ "null" ] }, - "login": { + "events_url": { "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "format": "uri-template" }, - "node_id": { + "followers_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "description": "Name of the project", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "owner_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, "avatar_url": { "type": "string", @@ -844187,38 +856003,1023 @@ "url" ] }, - "created_at": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2022-04-28T12:00:00Z" + "https://github.com/octocat/Hello-World" ] }, - "updated_at": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2022-04-28T12:00:00Z" + "2011-01-26T19:06:43Z" ] }, - "archived_at": { + "created_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2022-04-28T12:00:00Z" + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", - "content_node_id", - "content_type", + "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", - "archived_at" + "updated_at" ] }, "sender": { @@ -844385,8 +857186,7 @@ }, "required": [ "action", - "projects_v2_item", - "organization", + "project", "sender" ] } @@ -844400,20 +857200,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-deleted": { + "projects-v2-item-archived": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { "url": "" }, @@ -844480,15 +857281,39 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Deleted Event", + "title": "Projects v2 Item Archived Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "archived" ] }, + "changes": { + "type": "object", + "properties": { + "archived_at": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "to": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -845001,7 +857826,8 @@ "action", "projects_v2_item", "organization", - "sender" + "sender", + "changes" ] } } @@ -845023,11 +857849,11 @@ } } }, - "projects-v2-item-edited": { + "projects-v2-item-converted": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { "url": "" }, @@ -845094,62 +857920,33 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Edited Event", + "title": "Projects v2 Item Converted Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "converted" ] }, "changes": { - "oneOf": [ - { - "type": "object", - "properties": { - "field_value": { - "type": "object", - "properties": { - "field_node_id": { - "type": "string" - }, - "field_type": { - "type": "string" - } - } - } - }, - "required": [ - "field_value" - ] - }, - { + "type": "object", + "properties": { + "content_type": { "type": "object", "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - }, - "to": { - "type": [ - "string", - "null" - ] - } - } + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": "string" } - }, - "required": [ - "body" - ] + } } - ] + } }, "installation": { "title": "Simple Installation", @@ -845663,7 +858460,8 @@ "action", "projects_v2_item", "organization", - "sender" + "sender", + "changes" ] } } @@ -845685,11 +858483,11 @@ } } }, - "projects-v2-item-reordered": { + "projects-v2-item-created": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { "url": "" }, @@ -845756,37 +858554,15 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Reordered Event", + "title": "Projects v2 Item Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reordered" + "created" ] }, - "changes": { - "type": "object", - "properties": { - "previous_projects_v2_item_node_id": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ] - }, - "to": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -846299,8 +859075,7 @@ "action", "projects_v2_item", "organization", - "sender", - "changes" + "sender" ] } } @@ -846322,11 +859097,11 @@ } } }, - "projects-v2-item-restored": { + "projects-v2-item-deleted": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { "url": "" }, @@ -846393,39 +859168,15 @@ "content": { "application/json": { "schema": { - "title": "Projects v2 Item Restored Event", + "title": "Projects v2 Item Deleted Event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "restored" + "deleted" ] }, - "changes": { - "type": "object", - "properties": { - "archived_at": { - "type": "object", - "properties": { - "from": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "to": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - } - } - } - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", @@ -846938,8 +859689,7 @@ "action", "projects_v2_item", "organization", - "sender", - "changes" + "sender" ] } } @@ -846961,12 +859711,13 @@ } } }, - "public": { + "projects-v2-item-edited": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#public" + "url": "" }, "parameters": [ { @@ -846988,7 +859739,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -847031,97 +859782,61 @@ "content": { "application/json": { "schema": { - "title": "public event", + "title": "Projects v2 Item Edited Event", "type": "object", "properties": { - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "oneOf": [ + { + "type": "object", + "properties": { + "field_value": { + "type": "object", + "properties": { + "field_node_id": { + "type": "string" + }, + "field_type": { + "type": "string" + } + } + } + }, + "required": [ + "field_value" ] }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" + { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "required": [ + "body" ] - }, - "avatar_url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" ] }, "installation": { @@ -847248,50 +859963,2023 @@ "description" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "type": "integer", + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", "examples": [ - 42 + "2022-04-28T12:00:00Z" ] }, - "node_id": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "2022-04-28T12:00:00Z" ] }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { - "description": "The name of the repository.", + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "Team Environment" + "octocat" ] }, - "full_name": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "octocat/Hello-World" + "MDQ6VXNlcjE=" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-reordered": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Reordered Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reordered" + ] + }, + "changes": { + "type": "object", + "properties": { + "previous_projects_v2_item_node_id": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ] + }, + "to": { + "type": [ + "string", + "null" + ] + } + } + } + } + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-restored": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", + "externalDocs": { + "url": "" + }, + "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": "project-v2-item", + "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": "Projects v2 Item Restored Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "restored" + ] + }, + "changes": { + "type": "object", + "properties": { + "archived_at": { + "type": "object", + "properties": { + "from": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "to": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "projects_v2_item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "content_node_id": { + "type": "string" + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "public": { + "post": { + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#public" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "public event", + "type": "object", + "properties": { + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ "mit" ] }, @@ -860051,69 +874739,6223 @@ } }, "required": [ - "key", + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "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" + ] + }, + "reason": { + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "number", + "pull_request", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull-request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-closed": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/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": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "pull_request closed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "pull_request": { + "allOf": [ + { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. 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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit message title.", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title.", + "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 has been deprecated. 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", - "spdx_id", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", "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" + "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", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" ] }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { + "sha": { "type": "string" }, - "owner": { + "user": { "title": "User", "type": [ "object", @@ -860208,250 +881050,109 @@ "login", "id" ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } + } + }, + "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" }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" } }, - "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 has been deprecated. 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" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" ] }, - "sha": { + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { "type": "string" }, - "user": { + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { "title": "User", "type": [ "object", @@ -860546,395 +881247,30 @@ "login", "id" ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "changed_files": { - "type": "integer" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commits": { - "type": "integer" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "deletions": { - "type": "integer" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" }, - "repo": { - "title": "Repository", - "description": "A git repository", - "type": "object", + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "type": "boolean", - "default": false - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { + "closed_at": { "type": [ "string", "null" ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" + "format": "date-time" }, - "open_issues_count": { + "closed_issues": { "type": "integer" }, - "organization": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "owner": { + "creator": { "title": "User", "type": [ "object", @@ -861017,7 +881353,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -861030,134 +881367,51 @@ "id" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], + "description": { "type": [ - "null", - "integer", - "string" + "string", + "null" ] }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { + "due_on": { "type": [ "string", "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" + ], + "format": "date-time" }, - "stargazers_url": { + "html_url": { "type": "string", "format": "uri" }, - "statuses_url": { - "type": "string", - "format": "uri-template" + "id": { + "type": "integer" }, - "subscribers_url": { + "labels_url": { "type": "string", "format": "uri" }, - "subscription_url": { - "type": "string", - "format": "uri" + "node_id": { + "type": "string" }, - "svn_url": { - "type": "string", - "format": "uri" + "number": { + "description": "The number of the milestone.", + "type": "integer" }, - "tags_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, - "teams_url": { + "state": { + "description": "The state of the milestone.", "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } + "enum": [ + "open", + "closed" + ] }, - "trees_url": { - "type": "string", - "format": "uri-template" + "title": { + "description": "The title of the milestone.", + "type": "string" }, "updated_at": { "type": "string", @@ -861166,717 +881420,295 @@ "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 has been deprecated. 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": [ + "url", + "html_url", + "labels_url", "id", "node_id", - "name", - "full_name", - "private", - "owner", - "html_url", + "number", + "title", "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", + "creator", + "open_issues", + "closed_issues", + "state", "created_at", "updated_at", - "pushed_at", - "git_url", - "ssh_url", - "clone_url", - "svn_url", - "homepage", - "size", - "stargazers_count", - "watchers_count", - "language", - "has_issues", - "has_projects", - "has_downloads", - "has_wiki", - "has_pages", - "has_discussions", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] - }, - "sha": { - "type": "string" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged": { - "type": [ - "boolean", - "null" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" + "due_on", + "closed_at" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { + "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, - "created_at": { + "patch_url": { "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "description": { - "type": [ - "string", - "null" - ] + "format": "uri" }, - "due_on": { + "rebaseable": { "type": [ - "string", + "boolean", "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "labels_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" ] }, - "title": { - "description": "The title of the milestone.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "labels_url", - "id", - "node_id", - "number", - "title", - "description", - "creator", - "open_issues", - "closed_issues", - "state", - "created_at", - "updated_at", - "due_on", - "closed_at" - ] - }, - "node_id": { - "type": "string" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "type": "integer" - }, - "patch_url": { - "type": "string", - "format": "uri" - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "requested_reviewers": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", "type": [ - "string", + "object", "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" ] }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] - }, - "url": { - "type": "string", - "format": "uri" } - }, - "required": [ - "login", - "id" ] - }, - { + } + }, + "requested_teams": { + "type": "array", + "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", @@ -862008,334 +881840,1409 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - } - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" + "id" ] - }, - "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" + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + } + }, + "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" ] }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], + { + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" + "_links": { + "type": "object", + "properties": { + "comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "commits": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "issue": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comment": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "statuses": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } }, - "deleted": { - "type": "boolean" + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "email": { + "additions": { + "type": "integer" + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "auto_merge": { + "type": [ + "object", + "null" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "allow_auto_merge": { + "type": "boolean" + }, + "allow_forking": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "clone_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" + }, + "created_at": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "type": "boolean" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "has_downloads": { + "type": "boolean" + }, + "has_issues": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string" + }, + "license": { + "type": [ + "object", + "null" + ] + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "topics": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "trees_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "type": "boolean" + } + } + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + } + } + } + } + }, + "body": { "type": [ "string", "null" ] }, - "events_url": { - "type": "string", - "format": "uri-template" + "changed_files": { + "type": "integer" }, - "followers_url": { - "type": "string", - "format": "uri" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "following_url": { - "type": "string", - "format": "uri-template" + "comments": { + "type": "integer" }, - "gists_url": { - "type": "string", - "format": "uri-template" + "comments_url": { + "type": "string" }, - "gravatar_id": { + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { "type": "string" }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "type": "boolean" + }, + "allow_forking": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "clone_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" + }, + "created_at": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "type": "boolean" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "has_downloads": { + "type": "boolean" + }, + "has_issues": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string" + }, + "license": { + "type": [ + "object", + "null" + ] + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "owner": { + "type": [ + "object", + "null" + ], + "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" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "topics": { + "type": "array", + "items": { + "type": [ + "string", + "null" + ] + } + }, + "trees_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "type": "boolean" + } + } + }, + "sha": { + "type": "string" + }, + "user": { + "type": [ + "object", + "null" + ], + "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" + } + } + } + } + }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" }, "id": { "type": "integer" }, - "login": { + "issue_url": { "type": "string" }, - "name": { + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { "type": "string" }, + "merged": { + "type": "boolean" + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "merged_by": { + "type": [ + "object", + "null" + ] + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, "node_id": { "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri" + "number": { + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri" + "patch_url": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "rebaseable": { + "type": [ + "boolean", + "null" + ] }, - "site_admin": { - "type": "boolean" + "requested_reviewers": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + "requested_teams": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "review_comment_url": { + "type": "string" }, - "type": { + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" + "closed", + "open" ] }, + "statuses_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, "url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } } }, "required": [ - "login", - "id" + "state", + "closed_at", + "merged" ] } - }, - "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" ] }, - "reason": { - "type": "string" - }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -863995,11 +884902,11 @@ } } }, - "pull-request-closed": { + "pull-request-converted-to-draft": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" }, @@ -864066,13 +884973,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request closed event", + "title": "pull_request converted_to_draft event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed" + "converted_to_draft" ] }, "enterprise": { @@ -864517,8 +885424,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -864616,8 +885522,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -865271,7 +886176,7 @@ "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.", + "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", @@ -865600,10 +886505,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -865879,7 +886781,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", @@ -865888,7 +886790,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", @@ -866092,7 +886994,7 @@ "type": "integer" }, "squash_merge_commit_message": { - "description": "The default value for a 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", @@ -866101,7 +887003,7 @@ ] }, "squash_merge_commit_title": { - "description": "The default value for a 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", @@ -866362,322 +887264,321 @@ "login", "id" ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { - "type": "string" - }, - "merged": { - "type": [ - "boolean", - "null" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], - "properties": { - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] }, "description": { "type": [ @@ -866857,8 +887758,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -867003,16 +887903,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -867639,7 +888530,6 @@ }, "mirror_url": { "type": [ - "string", "null" ] }, @@ -867886,8 +888776,7 @@ "type": [ "string", "null" - ], - "format": "date-time" + ] }, "comments": { "type": "integer" @@ -867911,16 +888800,14 @@ "type": "string" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -868125,7 +889012,6 @@ }, "mirror_url": { "type": [ - "string", "null" ] }, @@ -868145,10 +889031,7 @@ "type": "integer" }, "owner": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "avatar_url": { "type": "string" @@ -868302,10 +889185,7 @@ "type": "string" }, "user": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "avatar_url": { "type": "string" @@ -868405,17 +889285,18 @@ "type": "string" }, "merged": { - "type": "boolean" + "type": "boolean", + "enum": [ + false + ] }, "merged_at": { "type": [ - "string", "null" ] }, "merged_by": { "type": [ - "object", "null" ] }, @@ -868468,12 +889349,7 @@ "type": "string" }, "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "type": "string", - "enum": [ - "closed", - "open" - ] + "type": "string" }, "statuses_url": { "type": "string" @@ -868548,9 +889424,11 @@ } }, "required": [ - "state", "closed_at", - "merged" + "merged_at", + "draft", + "merged", + "merged_by" ] } ] @@ -870214,11 +891092,11 @@ } } }, - "pull-request-converted-to-draft": { + "pull-request-demilestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" }, @@ -870285,13 +891163,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request converted_to_draft event", + "title": "pull_request demilestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "converted_to_draft" + "demilestoned" ] }, "enterprise": { @@ -870313,100 +891191,382 @@ "https://github.com/enterprises/octo-business" ] }, - "website_url": { - "description": "The enterprise's website URL.", + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "Tracking milestone for version 1.0" + ] }, - "id": { - "description": "Unique identifier of the enterprise", + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { "type": "integer", "examples": [ - 42 + 4 ] }, - "node_id": { - "type": "string", + "closed_issues": { + "type": "integer", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + 8 ] }, - "name": { - "description": "The name of the enterprise.", + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "Octo Business" + "2011-04-10T20:09:31Z" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "octo-business" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2019-01-26T19:01:12Z" + "2013-02-12T13:22:01Z" ] }, - "updated_at": { + "due_on": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "2012-10-09T23:39:01Z" ] - }, - "avatar_url": { - "type": "string", - "format": "uri" } }, "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", "id", "node_id", - "name", - "slug", + "labels_url", "html_url", + "number", + "open_issues", + "state", + "title", + "url", "created_at", - "updated_at", - "avatar_url" - ] - }, - "installation": { - "title": "Simple Installation", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" - ] - } - }, - "required": [ - "id", - "node_id" + "updated_at" ] }, "number": { @@ -870513,147 +891673,379 @@ ] }, "pull_request": { - "allOf": [ - { - "title": "Pull Request", + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { "type": "object", "properties": { - "_links": { + "comments": { + "title": "Link", "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" - ] + "href": { + "type": "string", + "format": "uri-template" } }, "required": [ - "self", - "html", - "issue", - "comments", - "review_comments", - "review_comment", - "commits", - "statuses" + "href" ] }, - "active_lock_reason": { + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null ] }, - "additions": { + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { "type": "integer" }, - "assignee": { + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "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" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { "title": "User", "type": [ "object", @@ -870749,1739 +892141,357 @@ "id" ] }, - "assignees": { - "type": "array", - "items": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", + "merge_method": { + "description": "The merge method to use.", "type": "string", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "merge", + "squash", + "rebase" ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "auto_merge": { - "title": "PullRequestAutoMerge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", "properties": { - "commit_message": { - "description": "Commit message for the merge commit.", - "type": [ - "string", - "null" - ] + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false }, - "commit_title": { - "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" }, - "enabled_by": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true }, - "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" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true }, - "ref": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true }, - "repo": { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { - "type": "string" - }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "name": { - "description": "The name of the repository.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { - "type": "string" - }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { - "type": [ - "string", - "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n - `PR_BODY` - default to the pull request's body.\n - `COMMIT_MESSAGES` - default to the branch's commit messages.\n - `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. 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", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" - ] + "allow_update_branch": { + "type": "boolean" }, - "sha": { - "type": "string" + "archive_url": { + "type": "string", + "format": "uri-template" }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_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" - ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "changed_files": { - "type": "integer" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "commits": { - "type": "integer" - }, - "commits_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "deletions": { - "type": "integer" - }, - "diff_url": { - "type": "string", - "format": "uri" - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false }, - "ref": { - "type": "string" + "assignees_url": { + "type": "string", + "format": "uri-template" }, - "repo": { - "title": "Repository", - "description": "A git repository", - "type": [ - "object", - "null" - ], - "properties": { - "allow_auto_merge": { - "description": "Whether to allow auto-merge for pull requests.", - "type": "boolean", - "default": false - }, - "allow_forking": { - "description": "Whether to allow private forks", - "type": "boolean" - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "type": "boolean", - "default": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "type": "boolean", - "default": true - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string", - "format": "uri-template" - }, - "archived": { - "description": "Whether the repository is archived.", - "type": "boolean", - "default": false - }, - "assignees_url": { - "type": "string", - "format": "uri-template" - }, - "blobs_url": { - "type": "string", - "format": "uri-template" - }, - "branches_url": { - "type": "string", - "format": "uri-template" - }, - "clone_url": { - "type": "string", - "format": "uri" - }, - "collaborators_url": { - "type": "string", - "format": "uri-template" - }, - "comments_url": { - "type": "string", - "format": "uri-template" - }, - "commits_url": { - "type": "string", - "format": "uri-template" - }, - "compare_url": { - "type": "string", - "format": "uri-template" - }, - "contents_url": { - "type": "string", - "format": "uri-template" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string" - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "type": "boolean", - "default": false - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "description": "Returns whether or not this repository is disabled.", - "type": "boolean" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string", - "format": "uri-template" - }, - "git_refs_url": { - "type": "string", - "format": "uri-template" - }, - "git_tags_url": { - "type": "string", - "format": "uri-template" - }, - "git_url": { - "type": "string", - "format": "uri" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "type": "boolean", - "default": true - }, - "has_issues": { - "description": "Whether issues are enabled.", - "type": "boolean", - "default": true - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "description": "Whether projects are enabled.", - "type": "boolean", - "default": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "type": "boolean", - "default": true - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the repository", + "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" }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string", - "format": "uri-template" - }, - "issue_events_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { + { "type": "string", - "format": "uri" - }, - "license": { - "title": "License", - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "key", - "name", - "spdx_id", - "url", - "node_id" - ] - }, - "master_branch": { + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { "type": "string" }, - "merge_commit_message": { - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string", - "format": "uri-template" - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, "name": { - "description": "The name of the repository.", "type": "string" }, "node_id": { "type": "string" }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "organization": { + "spdx_id": { "type": "string" }, - "owner": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "type": "boolean" - }, - "public": { - "type": "boolean" - }, - "pulls_url": { - "type": "string", - "format": "uri-template" - }, - "pushed_at": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "format": "date-time" - } - ], - "type": [ - "null", - "integer", - "string" - ] - }, - "releases_url": { - "type": "string", - "format": "uri-template" - }, - "role_name": { + "url": { "type": [ "string", "null" - ] - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "description": "The default value for a squash merge commit message:\n\n - `PR_BODY` - default to the pull request's body.\n - `COMMIT_MESSAGES` - default to the branch's commit messages.\n - `BLANK` - default to a blank commit message.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string", - "format": "uri-template" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "trees_url": { - "type": "string", - "format": "uri-template" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", + ], "format": "uri" - }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. 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", + "key", "name", - "full_name", - "private", - "owner", - "html_url", - "description", - "fork", + "spdx_id", "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", - "forks_count", - "mirror_url", - "archived", - "open_issues_count", - "license", - "forks", - "open_issues", - "watchers", - "default_branch", - "topics", - "visibility" + "node_id" ] }, - "sha": { + "master_branch": { "type": "string" }, - "user": { + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -872576,109 +892586,250 @@ "login", "id" ] - } - }, - "required": [ - "label", - "ref", - "sha", - "user", - "repo" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } }, - "node_id": { + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" } }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "description": "Indicates whether maintainers can modify the pull request.", - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" + "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.", + "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" ] }, - "mergeable_state": { + "sha": { "type": "string" }, - "merged": { - "type": [ - "boolean", - "null" - ] - }, - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "merged_by": { + "user": { "title": "User", "type": [ "object", @@ -872773,30 +892924,395 @@ "login", "id" ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": [ - "object", - "null" - ], + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", "properties": { - "closed_at": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { "type": [ "string", "null" - ], - "format": "date-time" + ] }, - "closed_issues": { + "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" }, - "created_at": { + "forks_count": { + "type": "integer" + }, + "forks_url": { "type": "string", - "format": "date-time" + "format": "uri" }, - "creator": { + "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 + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { "title": "User", "type": [ "object", @@ -872892,18 +893408,286 @@ "id" ] }, - "description": { + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { "type": [ "string", "null" ] }, - "due_on": { + "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.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ "string", "null" - ], - "format": "date-time" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" }, "html_url": { "type": "string", @@ -872912,35 +893696,362 @@ "id": { "type": "integer" }, - "labels_url": { - "type": "string", - "format": "uri" + "login": { + "type": "string" + }, + "name": { + "type": "string" }, "node_id": { "type": "string" }, - "number": { - "description": "The number of the milestone.", - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri" }, - "open_issues": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "state": { - "description": "The state of the milestone.", + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string", "enum": [ - "open", - "closed" + "Bot", + "User", + "Organization" ] }, - "title": { - "description": "The title of the milestone.", + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { "type": "string" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, "url": { "type": "string", @@ -872948,282 +894059,202 @@ } }, "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" + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" ] }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, "node_id": { "type": "string" }, "number": { - "description": "Number uniquely identifying the pull request within its repository.", + "description": "The number of the milestone.", "type": "integer" }, - "patch_url": { - "type": "string", - "format": "uri" + "open_issues": { + "type": "integer" }, - "rebaseable": { - "type": [ - "boolean", - "null" + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" ] }, - "requested_reviewers": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "User", + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { "type": [ - "object", + "string", "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id" ] }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "deleted": { - "type": "boolean" - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "parent": { - "type": [ - "object", - "null" - ], - "properties": { - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the team", - "type": "integer" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "name": { - "description": "Name of the team", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string" - }, - "privacy": { - "type": "string", - "enum": [ - "open", - "closed", - "secret" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "slug": { - "type": "string" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri" - } - }, - "required": [ - "name", - "id" + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_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" ] - } - }, - "requested_teams": { - "type": "array", - "items": { + }, + { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", @@ -873358,1391 +894389,317 @@ "id" ] } - }, - "review_comment_url": { - "type": "string", - "format": "uri-template" - }, - "review_comments": { - "type": "integer" - }, - "review_comments_url": { - "type": "string", - "format": "uri" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "title": { - "description": "The title of the pull request.", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "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" - ] - } - }, - "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" - ] + ] + } }, - { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "comments": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "commits": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "issue": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "review_comment": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "review_comments": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "self": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - }, - "statuses": { - "type": "object", - "properties": { - "href": { - "type": "string" - } - } - } - } - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "additions": { - "type": "integer" - }, - "assignee": { - "type": [ - "object", - "null" - ] - }, - "assignees": { - "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": [ - "object", + "string", "null" ] - } - }, - "author_association": { - "type": "string" - }, - "auto_merge": { - "type": [ - "object", - "null" - ] - }, - "base": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "allow_auto_merge": { - "type": "boolean" - }, - "allow_forking": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "clone_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" - }, - "created_at": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "deployments_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "type": "boolean" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string" - }, - "license": { - "type": [ - "object", - "null" - ] - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "null" - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "topics": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "trees_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "type": "boolean" - } + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" } }, - "sha": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } + "required": [ + "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" } }, - "body": { - "type": [ - "string", - "null" - ] + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" }, - "changed_files": { - "type": "integer" + "deleted": { + "type": "boolean" }, - "closed_at": { + "email": { "type": [ "string", "null" ] }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string" - }, - "commits": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri-template" }, - "commits_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri" }, - "created_at": { - "type": "string" + "following_url": { + "type": "string", + "format": "uri-template" }, - "deletions": { - "type": "integer" + "gists_url": { + "type": "string", + "format": "uri-template" }, - "diff_url": { + "gravatar_id": { "type": "string" }, - "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": { - "type": [ - "object", - "null" - ], - "properties": { - "allow_auto_merge": { - "type": "boolean" - }, - "allow_forking": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "archive_url": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "clone_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" - }, - "created_at": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "deployments_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "type": "boolean" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "forks_url": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "languages_url": { - "type": "string" - }, - "license": { - "type": [ - "object", - "null" - ] - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "null" - ] - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "topics": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - } - }, - "trees_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string" - }, - "use_squash_pr_title_as_default": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - } - }, - "sha": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } - } - } - }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "integer" }, - "issue_url": { + "login": { "type": "string" }, - "labels": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "locked": { - "type": "boolean" - }, - "maintainer_can_modify": { - "type": "boolean" - }, - "merge_commit_sha": { - "type": [ - "string", - "null" - ] - }, - "mergeable": { - "type": [ - "boolean", - "null" - ] - }, - "mergeable_state": { + "name": { "type": "string" }, - "merged": { - "type": "boolean", - "enum": [ - false - ] - }, - "merged_at": { - "type": [ - "null" - ] - }, - "merged_by": { - "type": [ - "null" - ] - }, - "milestone": { - "type": [ - "object", - "null" - ] - }, "node_id": { "type": "string" }, - "number": { - "type": "integer" - }, - "patch_url": { - "type": "string" - }, - "rebaseable": { - "type": [ - "boolean", - "null" - ] - }, - "requested_reviewers": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "requested_teams": { - "type": "array", - "items": { - "type": [ - "object", - "null" - ] - } - }, - "review_comment_url": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri" }, - "review_comments": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri" }, - "review_comments_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri" }, - "state": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "statuses_url": { - "type": "string" + "starred_url": { + "type": "string", + "format": "uri-template" }, - "title": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri" }, - "updated_at": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, "url": { - "type": "string" - }, - "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "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" - } - } + "type": "string", + "format": "uri" } }, "required": [ - "closed_at", - "merged_at", - "draft", - "merged", - "merged_by" + "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": { @@ -876380,8 +896337,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -876404,11 +896360,11 @@ } } }, - "pull-request-demilestoned": { + "pull-request-dequeued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "description": "A pull request was removed from the merge queue.\n\n**Note**: The pull request merge queue feature is currently in limited public beta and subject to change.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request" }, @@ -876475,13 +896431,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request demilestoned event", + "title": "pull_request dequeued event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "demilestoned" + "dequeued" ] }, "enterprise": { @@ -876574,315 +896530,32 @@ "avatar_url" ] }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, "id": { + "description": "The ID of the installation.", "type": "integer", "examples": [ - 1002604 + 1 ] }, "node_id": { + "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" + "MDQ6VXNlcjU4MzIzMQ==" ] } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" + "node_id" ] }, "number": { - "description": "The pull request number.", "type": "integer" }, "organization": { @@ -877206,8 +896879,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -877305,8 +896977,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -878037,7 +897708,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -878858,7 +898529,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -879242,8 +898913,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -880014,6 +899684,9 @@ "draft" ] }, + "reason": { + "type": "string" + }, "repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -881649,7 +901322,9 @@ "action", "number", "pull_request", - "repository" + "repository", + "sender", + "reason" ] } } @@ -1056282,10 +1075957,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1058672,10 +1078354,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1061231,10 +1080920,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1066013,10 +1085709,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index a0a73f5f4a1c..8c00d8627d95 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -8023,6 +8023,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -8751,6 +8759,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -36505,6 +36518,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -36527,6 +36546,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -77144,6 +77166,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -77166,6 +77194,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -82940,6 +82971,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -83704,6 +83743,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -146694,7 +146738,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-branches" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branches#list-branches" }, "parameters": [ { @@ -148061,8 +148105,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -148076,7 +148119,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -150221,8 +150264,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -150236,7 +150278,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -151711,8 +151753,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -151724,7 +151766,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -153362,8 +153404,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -153375,7 +153417,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -153441,8 +153483,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -153456,7 +153498,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -153532,8 +153574,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -153545,7 +153587,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -153621,8 +153663,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -153634,7 +153676,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -153700,8 +153742,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -153715,7 +153757,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -154608,8 +154650,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -154621,7 +154663,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -155671,8 +155713,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -155684,7 +155726,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -155750,8 +155792,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -155765,7 +155807,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -155867,8 +155909,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -155880,7 +155922,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -155982,8 +156024,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -155995,7 +156037,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -156061,8 +156103,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -156076,7 +156118,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -156200,8 +156242,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -156213,7 +156255,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -156446,8 +156488,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -156459,7 +156501,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -156499,8 +156541,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -156514,7 +156556,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -156597,8 +156639,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -156610,7 +156652,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -156845,8 +156887,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -156858,7 +156900,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -157065,8 +157107,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -157078,7 +157120,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -157284,8 +157326,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -157299,7 +157341,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -157763,8 +157805,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -157776,7 +157818,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -157816,8 +157858,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -157831,7 +157873,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -158276,8 +158318,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -158289,7 +158331,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -158830,8 +158872,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -158843,7 +158885,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -159384,8 +159426,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -159397,7 +159439,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -159937,8 +159979,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -159952,7 +159994,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -160245,8 +160287,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -160258,7 +160300,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -160649,8 +160691,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -160662,7 +160704,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -161053,8 +161095,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -161066,7 +161108,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -161456,8 +161498,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -161471,7 +161513,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -161731,8 +161773,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -161744,7 +161786,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -162101,8 +162143,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -162114,7 +162156,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -162471,8 +162513,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -162484,7 +162526,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -162840,8 +162882,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -162855,7 +162897,7 @@ "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -165096,8 +165138,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -229426,6 +229467,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -299390,6 +299436,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -299695,7 +299746,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -299791,8 +299842,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -299806,7 +299856,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.3/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -300766,8 +300816,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -356046,10 +356095,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -356454,10 +356510,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -356843,10 +356906,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -358021,6 +358091,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -358144,6 +358219,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -358460,6 +358540,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 397b50f3f408..940592ddeaf0 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -7999,6 +7999,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -8727,6 +8735,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -35425,6 +35438,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -35447,6 +35466,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -78422,6 +78444,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -78444,6 +78472,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -85782,6 +85813,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -86546,6 +86585,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -156515,7 +156559,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-branches" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#list-branches" }, "parameters": [ { @@ -158608,8 +158652,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -158623,7 +158666,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -161494,8 +161537,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -161509,7 +161551,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -163710,8 +163752,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -163723,7 +163765,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -166110,8 +166152,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -166123,7 +166165,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -166189,8 +166231,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -166204,7 +166246,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -166280,8 +166322,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -166293,7 +166335,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -166369,8 +166411,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -166382,7 +166424,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -166448,8 +166490,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -166463,7 +166505,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -168060,8 +168102,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -168073,7 +168115,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -169854,8 +169896,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -169867,7 +169909,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -169933,8 +169975,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -169948,7 +169990,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -170050,8 +170092,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -170063,7 +170105,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -170165,8 +170207,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -170178,7 +170220,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -170244,8 +170286,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -170259,7 +170301,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -170408,8 +170450,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -170421,7 +170463,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -170699,8 +170741,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -170712,7 +170754,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -170752,8 +170794,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -170767,7 +170809,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -170850,8 +170892,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -170863,7 +170905,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -171098,8 +171140,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -171111,7 +171153,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -171318,8 +171360,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -171331,7 +171373,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -171537,8 +171579,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -171552,7 +171594,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -172016,8 +172058,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -172029,7 +172071,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -172069,8 +172111,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -172084,7 +172126,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -172529,8 +172571,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -172542,7 +172584,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -173083,8 +173125,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -173096,7 +173138,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -173637,8 +173679,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -173650,7 +173692,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -174190,8 +174232,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -174205,7 +174247,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -174498,8 +174540,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -174511,7 +174553,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -174902,8 +174944,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -174915,7 +174957,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -175306,8 +175348,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -175319,7 +175361,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -175709,8 +175751,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -175724,7 +175766,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -175984,8 +176026,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -175997,7 +176039,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -176354,8 +176396,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -176367,7 +176409,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -176724,8 +176766,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -176737,7 +176779,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -177093,8 +177135,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -177108,7 +177150,7 @@ "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -180075,8 +180117,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -244653,6 +244694,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -314609,6 +314655,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -314914,7 +314965,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -315010,8 +315061,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -315025,7 +315075,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -315985,8 +316035,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -371464,10 +371513,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -371872,10 +371928,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -372261,10 +372324,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -373439,6 +373509,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -373562,6 +373637,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -373878,6 +373958,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index 99adc148f060..8c83b5b4051f 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -7999,6 +7999,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -8727,6 +8735,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -35791,6 +35804,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -35813,6 +35832,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -79308,6 +79330,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -79330,6 +79358,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -88116,6 +88147,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -88880,6 +88919,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -163640,7 +163684,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-branches" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#list-branches" }, "parameters": [ { @@ -165733,8 +165777,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -165748,7 +165791,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -168619,8 +168662,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -168634,7 +168676,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -170835,8 +170877,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -170848,7 +170890,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -173235,8 +173277,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -173248,7 +173290,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -173314,8 +173356,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -173329,7 +173371,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -173405,8 +173447,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -173418,7 +173460,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -173494,8 +173536,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -173507,7 +173549,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -173573,8 +173615,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -173588,7 +173630,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -175185,8 +175227,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -175198,7 +175240,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -176979,8 +177021,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -176992,7 +177034,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -177058,8 +177100,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -177073,7 +177115,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -177175,8 +177217,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -177188,7 +177230,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -177290,8 +177332,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -177303,7 +177345,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -177369,8 +177411,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -177384,7 +177426,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -177533,8 +177575,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -177546,7 +177588,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -177824,8 +177866,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -177837,7 +177879,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -177877,8 +177919,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -177892,7 +177934,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -177975,8 +178017,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -177988,7 +178030,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -178223,8 +178265,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -178236,7 +178278,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -178443,8 +178485,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -178456,7 +178498,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -178662,8 +178704,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -178677,7 +178719,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -179141,8 +179183,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -179154,7 +179196,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -179194,8 +179236,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -179209,7 +179251,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -179654,8 +179696,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -179667,7 +179709,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -180208,8 +180250,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -180221,7 +180263,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -180762,8 +180804,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -180775,7 +180817,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -181315,8 +181357,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -181330,7 +181372,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -181623,8 +181665,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -181636,7 +181678,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -182027,8 +182069,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -182040,7 +182082,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -182431,8 +182473,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -182444,7 +182486,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -182834,8 +182876,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -182849,7 +182891,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -183109,8 +183151,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -183122,7 +183164,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -183479,8 +183521,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -183492,7 +183534,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -183849,8 +183891,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -183862,7 +183904,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -184218,8 +184260,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -184233,7 +184275,7 @@ "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -187200,8 +187242,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -252016,6 +252057,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -321984,6 +322030,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -322289,7 +322340,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -322385,8 +322436,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -322400,7 +322450,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -323360,8 +323410,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -378845,10 +378894,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -379257,10 +379313,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -379651,10 +379714,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -380834,6 +380904,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -380957,6 +381032,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -381273,6 +381353,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index 0a3791062913..5dab09e28dce 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -7999,6 +7999,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -8727,6 +8735,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -36183,6 +36196,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -36205,6 +36224,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -80536,6 +80558,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -80558,6 +80586,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -89797,6 +89828,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -90561,6 +90600,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -167674,7 +167718,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-branches" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#list-branches" }, "parameters": [ { @@ -169767,8 +169811,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -169782,7 +169825,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -172653,8 +172696,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -172668,7 +172710,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -174869,8 +174911,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -174882,7 +174924,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -177269,8 +177311,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -177282,7 +177324,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -177348,8 +177390,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -177363,7 +177405,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -177439,8 +177481,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -177452,7 +177494,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -177528,8 +177570,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -177541,7 +177583,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -177607,8 +177649,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -177622,7 +177664,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -179219,8 +179261,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -179232,7 +179274,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -181013,8 +181055,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -181026,7 +181068,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -181092,8 +181134,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -181107,7 +181149,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -181209,8 +181251,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -181222,7 +181264,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -181324,8 +181366,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -181337,7 +181379,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -181403,8 +181445,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -181418,7 +181460,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -181567,8 +181609,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -181580,7 +181622,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -181858,8 +181900,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -181871,7 +181913,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -181911,8 +181953,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -181926,7 +181968,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -182009,8 +182051,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -182022,7 +182064,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -182257,8 +182299,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -182270,7 +182312,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -182477,8 +182519,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -182490,7 +182532,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -182696,8 +182738,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -182711,7 +182753,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -183175,8 +183217,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -183188,7 +183230,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -183228,8 +183270,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -183243,7 +183285,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -183688,8 +183730,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -183701,7 +183743,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -184242,8 +184284,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -184255,7 +184297,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -184796,8 +184838,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -184809,7 +184851,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -185349,8 +185391,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -185364,7 +185406,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -185657,8 +185699,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -185670,7 +185712,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -186061,8 +186103,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -186074,7 +186116,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -186465,8 +186507,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -186478,7 +186520,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -186868,8 +186910,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -186883,7 +186925,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -187143,8 +187185,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -187156,7 +187198,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -187513,8 +187555,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -187526,7 +187568,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -187883,8 +187925,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -187896,7 +187938,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -188252,8 +188294,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -188267,7 +188309,7 @@ "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -191234,8 +191276,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -256981,6 +257022,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -327699,6 +327745,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -328004,7 +328055,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -328100,8 +328151,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -328115,7 +328165,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -329075,8 +329125,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -385104,10 +385153,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -385699,10 +385755,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -386277,10 +386340,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -387644,6 +387714,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -387767,6 +387842,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -388083,6 +388163,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.7.deref.json b/lib/rest/static/dereferenced/ghes-3.7.deref.json index 682c293c90d0..61ad468724a1 100644 --- a/lib/rest/static/dereferenced/ghes-3.7.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.7.deref.json @@ -8020,6 +8020,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -8748,6 +8756,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -36228,6 +36241,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -36250,6 +36269,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -82385,6 +82407,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -82407,6 +82435,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -91657,6 +91688,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -92421,6 +92460,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -170913,7 +170957,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-branches" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branches#list-branches" }, "parameters": [ { @@ -173006,8 +173050,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -173021,7 +173064,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -175892,8 +175935,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -175907,7 +175949,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -178108,8 +178150,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -178121,7 +178163,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -180508,8 +180550,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -180521,7 +180563,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -180587,8 +180629,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -180602,7 +180644,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -180678,8 +180720,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -180691,7 +180733,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -180767,8 +180809,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -180780,7 +180822,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -180846,8 +180888,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -180861,7 +180903,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -182458,8 +182500,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -182471,7 +182513,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -184252,8 +184294,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -184265,7 +184307,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -184331,8 +184373,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -184346,7 +184388,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -184448,8 +184490,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -184461,7 +184503,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -184563,8 +184605,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -184576,7 +184618,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -184642,8 +184684,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -184657,7 +184699,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -184806,8 +184848,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -184819,7 +184861,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -185097,8 +185139,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -185110,7 +185152,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -185150,8 +185192,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -185165,7 +185207,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -185248,8 +185290,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -185261,7 +185303,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -185496,8 +185538,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -185509,7 +185551,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -185716,8 +185758,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -185729,7 +185771,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -185935,8 +185977,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -185950,7 +185992,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -186414,8 +186456,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -186427,7 +186469,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -186467,8 +186509,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -186482,7 +186524,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -186927,8 +186969,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -186940,7 +186982,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -187481,8 +187523,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -187494,7 +187536,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -188035,8 +188077,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -188048,7 +188090,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -188588,8 +188630,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -188603,7 +188645,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -188896,8 +188938,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -188909,7 +188951,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -189300,8 +189342,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -189313,7 +189355,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -189704,8 +189746,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -189717,7 +189759,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -190107,8 +190149,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -190122,7 +190164,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -190382,8 +190424,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -190395,7 +190437,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -190752,8 +190794,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -190765,7 +190807,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -191122,8 +191164,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -191135,7 +191177,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -191491,8 +191533,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -191506,7 +191548,7 @@ "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -194473,8 +194515,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -260736,6 +260777,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -331583,6 +331629,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -331888,7 +331939,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -331984,8 +332035,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -331999,7 +332049,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.7/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -332959,8 +333009,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -389364,10 +389413,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -389959,589 +390015,603 @@ "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 - }, - "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." - }, - "state": { - "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": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - null, - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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 \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.7/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": 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." + }, + "state": { + "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": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + null, + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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 \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.7/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + } + } + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", + "state": "open", + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "push_protection_bypassed": false + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": null + } + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "operationId": "secret-scanning/update-alert", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "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": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + null, + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + } + }, + "required": [ + "state" + ] + }, + "examples": { + "default": { + "value": { + "state": "resolved", + "resolution": "false_positive" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } ] }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - } - } - }, - "examples": { - "default": { - "value": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", - "state": "open", - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed": false - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": null - } - }, - "patch": { - "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", - "operationId": "secret-scanning/update-alert", - "tags": [ - "secret-scanning" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.7/rest/reference/secret-scanning#update-a-secret-scanning-alert" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "alert_number", - "in": "path", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "required": true, - "schema": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "state": { - "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": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - null, - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - } - }, - "required": [ - "state" - ] - }, - "examples": { - "default": { - "value": { - "state": "resolved", - "resolution": "false_positive" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "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 - }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", @@ -391904,6 +391974,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -392027,6 +392102,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -392343,6 +392423,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -508286,360 +508371,14929 @@ } }, "required": [ - "check_run", + "check_run", + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Created Event", + "description": "The check_run.created webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-requested-action": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.7/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.7/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Check Run Requested Action Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested_action" + ] + }, + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", + "type": "object", + "properties": { + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ], + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" + ] + }, + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "before": { + "type": [ + "string", + "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], + "examples": [ + "neutral" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] + } + } + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example" + ] + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "details_url": { + "type": "string", + "examples": [ + "https://example.com" + ] + }, + "external_id": { + "type": "string", + "examples": [ + "42" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "started_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ], + "examples": [ + "queued" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "requested_action": { + "description": "The action requested by the user.", + "type": "object", + "properties": { + "identifier": { + "description": "The integrator reference of the action requested by the user.", + "type": "string" + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "check_run", + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "requested_action", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } + }, + "requested_action": { + "identifier": "lgtm|1234" + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Requested Action Event", + "description": "The check_run.requested_action webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-rerequested": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.7/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Check Run Re-Requested Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "rerequested" + ] + }, + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", + "type": "object", + "properties": { + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ], + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" + ] + }, + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "before": { + "type": [ + "string", + "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], + "examples": [ + "neutral" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] + } + } + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example" + ] + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "details_url": { + "type": "string", + "examples": [ + "https://example.com" + ] + }, + "external_id": { + "type": "string", + "examples": [ + "42" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "started_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ], + "examples": [ + "queued" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + "check_run", + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "rerequested", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "completed", + "conclusion": "success", + "started_at": "2019-05-15T15:21:12Z", + "completed_at": "2019-05-15T15:21:45Z", + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "completed", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Re-Requested Event", + "description": "The check_run.rerequested webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.7/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "check_suite completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#suites).", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ] + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_group", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "projects_v2_item", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "before": { + "type": [ + "string", + "null" + ] + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL that points to the check suite API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", + "url", + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "check_suite", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check-suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.7/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.7/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.7/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "check_suite requested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#suites).", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ] + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "secret_scanning_alert_location", + "projects_v2_item", + "merge_group", + "repository_import" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "before": { + "type": [ + "string", + "null" + ] + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL that points to the check suite API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", + "url", + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "check_suite", "repository", "sender" ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "check_run": { - "id": 128620228, - "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "external_id": "", - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", - "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", - "details_url": "https://octocoders.github.io", - "status": "queued", - "conclusion": null, - "started_at": "2019-05-15T15:21:12Z", - "completed_at": null, - "output": { - "title": null, - "summary": null, - "text": null, - "annotations_count": 0, - "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" - }, - "name": "Octocoders-linter", - "check_suite": { - "id": 118578147, - "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "head_branch": "changes", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "status": "queued", - "conclusion": null, - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", - "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ], - "deployment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", - "id": 326191728, - "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", - "task": "deploy", - "original_environment": "lab", - "environment": "lab", - "description": null, - "created_at": "2021-02-18T08:22:48Z", - "updated_at": "2021-02-18T09:47:16Z", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" - }, - "app": { - "id": 29310, - "node_id": "MDM6QXBwMjkzMTA=", - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "name": "octocoders-linter", - "description": "", - "external_url": "https://octocoders.github.io", - "html_url": "https://github.com/apps/octocoders-linter", - "created_at": "2019-04-19T19:36:24Z", - "updated_at": "2019-04-19T19:36:56Z", - "permissions": { - "administration": "write", - "checks": "write", - "contents": "write", - "deployments": "write", - "issues": "write", - "members": "write", - "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", - "pages": "write", - "pull_requests": "write", - "repository_hooks": "write", - "repository_projects": "write", - "statuses": "write", - "team_discussions": "write", - "vulnerability_alerts": "read" - }, - "events": [ - - ] - }, - "created_at": "2019-05-15T15:20:31Z", - "updated_at": "2019-05-15T15:20:31Z" - }, - "app": { - "id": 29310, - "node_id": "MDM6QXBwMjkzMTA=", - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "name": "octocoders-linter", - "description": "", - "external_url": "https://octocoders.github.io", - "html_url": "https://github.com/apps/octocoders-linter", - "created_at": "2019-04-19T19:36:24Z", - "updated_at": "2019-04-19T19:36:56Z", - "permissions": { - "administration": "write", - "checks": "write", - "contents": "write", - "deployments": "write", - "issues": "write", - "members": "write", - "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", - "pages": "write", - "pull_requests": "write", - "repository_hooks": "write", - "repository_projects": "write", - "statuses": "write", - "team_discussions": "write", - "vulnerability_alerts": "read" - }, - "events": [ - - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ] - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/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": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Check Run Created Event", - "description": "The check_run.created webhook encoded with URL encoding", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" - ] - }, - "examples": { - "default": { - "value": { - "payload": "%7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" - } - } } } } @@ -508651,9 +523305,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -508662,11 +523315,11 @@ } } }, - "check-suite-completed": { + "check-suite-rerequested": { "post": { "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.7/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.7/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.7/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.7/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" }, @@ -508749,20 +523402,36 @@ "content": { "application/json": { "schema": { - "title": "check_suite completed event", + "title": "check_suite rerequested event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "completed" + "rerequested" ] }, "actions_meta": { "type": [ "object", "null" - ] + ], + "properties": { + "rerun_info": { + "type": "object", + "properties": { + "plan_id": { + "type": "string" + }, + "job_ids": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } }, "check_suite": { "description": "The [check_suite](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#suites).", @@ -508843,13 +523512,9 @@ "watch", "workflow_dispatch", "workflow_run", - "merge_group", "pull_request_review_thread", - "workflow_job", "merge_queue_entry", - "security_and_analysis", - "projects_v2_item", - "secret_scanning_alert_location" + "workflow_job" ] } }, @@ -509262,7 +523927,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", "type": [ "string", "null" @@ -509275,9 +523940,7 @@ "timed_out", "action_required", "stale", - null, - "skipped", - "startup_failure" + null ] }, "created_at": { @@ -509506,8 +524169,7 @@ "in_progress", "completed", "queued", - null, - "pending" + null ] }, "updated_at": { @@ -997322,10 +1011984,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -999721,10 +1014390,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1002289,10 +1016965,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -1007096,10 +1021779,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 383d9c625ff5..20c420e05246 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -6129,6 +6129,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -6856,6 +6864,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -23414,6 +23427,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -23436,6 +23455,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -56131,6 +56153,12 @@ "org_id": { "type": "integer" }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, "blocked_user": { "type": "string", "description": "The username of the account being blocked." @@ -56153,6 +56181,9 @@ "content_type": { "type": "string" }, + "operation_type": { + "type": "string" + }, "created_at": { "type": "integer", "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." @@ -59776,6 +59807,14 @@ "schema": { "type": "string" } + }, + { + "name": "redelivery", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -60539,6 +60578,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -131001,7 +131045,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#list-branches" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branches#list-branches" }, "parameters": [ { @@ -133094,8 +133138,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -133109,7 +133152,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-branch" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -135980,8 +136023,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -135995,7 +136037,7 @@ "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-branch-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -138196,8 +138238,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -138209,7 +138251,7 @@ "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-branch-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -140596,8 +140638,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -140609,7 +140651,7 @@ "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-branch-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -140675,8 +140717,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -140690,7 +140732,7 @@ "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-admin-branch-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -140766,8 +140808,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -140779,7 +140821,7 @@ "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#set-admin-branch-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -140855,8 +140897,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -140868,7 +140910,7 @@ "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-admin-branch-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -140934,8 +140976,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -140949,7 +140991,7 @@ "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-pull-request-review-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -142546,8 +142588,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -142559,7 +142601,7 @@ "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-pull-request-review-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -144340,8 +144382,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -144353,7 +144395,7 @@ "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-pull-request-review-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -144419,8 +144461,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -144434,7 +144476,7 @@ "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-commit-signature-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -144536,8 +144578,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -144549,7 +144591,7 @@ "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#create-commit-signature-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -144651,8 +144693,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -144664,7 +144706,7 @@ "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-commit-signature-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -144730,8 +144772,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -144745,7 +144787,7 @@ "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-status-checks-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -144894,8 +144936,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "patch": { @@ -144907,7 +144949,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -145185,8 +145227,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -145198,7 +145240,7 @@ "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#remove-status-check-protection" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -145238,8 +145280,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -145253,7 +145295,7 @@ "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-all-status-check-contexts" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -145336,8 +145378,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -145349,7 +145391,7 @@ "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#add-status-check-contexts" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -145584,8 +145626,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -145597,7 +145639,7 @@ "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#set-status-check-contexts" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -145804,8 +145846,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -145817,7 +145859,7 @@ "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#remove-status-check-contexts" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -146023,8 +146065,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "contexts", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -146038,7 +146080,7 @@ "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -146502,8 +146544,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -146515,7 +146557,7 @@ "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -146555,8 +146597,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -146570,7 +146612,7 @@ "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -147015,8 +147057,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -147028,7 +147070,7 @@ "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#add-app-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -147569,8 +147611,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -147582,7 +147624,7 @@ "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -148123,8 +148165,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -148136,7 +148178,7 @@ "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -148676,8 +148718,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -148691,7 +148733,7 @@ "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -148984,8 +149026,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -148997,7 +149039,7 @@ "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -149388,8 +149430,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -149401,7 +149443,7 @@ "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -149792,8 +149834,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -149805,7 +149847,7 @@ "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -150195,8 +150237,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -150210,7 +150252,7 @@ "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#list-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -150470,8 +150512,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "post": { @@ -150483,7 +150525,7 @@ "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#add-user-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -150840,8 +150882,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "put": { @@ -150853,7 +150895,7 @@ "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#set-user-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -151210,8 +151252,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } }, "delete": { @@ -151223,7 +151265,7 @@ "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#remove-user-access-restrictions" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -151579,8 +151621,8 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "requestBodyParameterName": "users", - "category": "repos", - "subcategory": "branches" + "category": "branches", + "subcategory": "branch-protection" } } }, @@ -216065,6 +216107,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -286126,6 +286173,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -286431,7 +286483,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -286527,8 +286579,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "branches" + "category": "branches" } } }, @@ -286542,7 +286593,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#merge-a-branch" + "url": "https://docs.github.com/github-ae@latest/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -287502,8 +287553,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "merging" + "category": "branches" } } }, @@ -342370,10 +342420,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -342756,414 +342813,428 @@ "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 - }, - "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." - }, - "state": { - "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": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - null, - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": 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." + }, + "state": { + "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": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + null, + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", + "state": "open", + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": null + } + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "operationId": "secret-scanning/update-alert", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "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": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + null, + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "resolution_comment": { + "description": "An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "state" + ] + }, + "examples": { + "default": { + "value": { + "state": "resolved", + "resolution": "false_positive" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } ] }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment to resolve an alert." - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - } - } - }, - "examples": { - "default": { - "value": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", - "state": "open", - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": null - } - }, - "patch": { - "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", - "operationId": "secret-scanning/update-alert", - "tags": [ - "secret-scanning" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/secret-scanning#update-a-secret-scanning-alert" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "alert_number", - "in": "path", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "required": true, - "schema": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "state": { - "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": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - null, - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "resolution_comment": { - "description": "An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "state" - ] - }, - "examples": { - "default": { - "value": { - "state": "resolved", - "resolution": "false_positive" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "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 - }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", @@ -344348,6 +344419,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -344471,6 +344547,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -344787,6 +344868,11 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "default": { + "value": null + } } } } @@ -430861,360 +430947,14525 @@ } }, "required": [ - "check_run", + "check_run", + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Created Event", + "description": "The check_run.created webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-requested-action": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/github-ae@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/github-ae@latest/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", + "externalDocs": { + "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Check Run Requested Action Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested_action" + ] + }, + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", + "type": "object", + "properties": { + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ], + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" + ] + }, + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "before": { + "type": [ + "string", + "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], + "examples": [ + "neutral" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] + } + } + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example" + ] + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "details_url": { + "type": "string", + "examples": [ + "https://example.com" + ] + }, + "external_id": { + "type": "string", + "examples": [ + "42" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "started_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ], + "examples": [ + "queued" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "requested_action": { + "description": "The action requested by the user.", + "type": "object", + "properties": { + "identifier": { + "description": "The integrator reference of the action requested by the user.", + "type": "string" + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "check_run", + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "requested_action", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } + }, + "requested_action": { + "identifier": "lgtm|1234" + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Requested Action Event", + "description": "The check_run.requested_action webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-rerequested": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/github-ae@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", + "externalDocs": { + "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Check Run Re-Requested Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "rerequested" + ] + }, + "check_run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", + "type": "object", + "properties": { + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "check_suite": { + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ], + "examples": [ + "d6fde92930d4715a2b49857d24b940956b26d2d3" + ] + }, + "app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "before": { + "type": [ + "string", + "null" + ], + "examples": [ + "146e867f55c26428e5f9fade55a9bbf5e95a7912" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ], + "examples": [ + "neutral" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ], + "examples": [ + "completed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-suites/5" + ] + } + } + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example" + ] + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "details_url": { + "type": "string", + "examples": [ + "https://example.com" + ] + }, + "external_id": { + "type": "string", + "examples": [ + "42" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "started_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ], + "examples": [ + "queued" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + "check_run", + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "rerequested", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "completed", + "conclusion": "success", + "started_at": "2019-05-15T15:21:12Z", + "completed_at": "2019-05-15T15:21:45Z", + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "completed", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "team_discussions": "write", + "vulnerability_alerts": "read" + }, + "events": [ + + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/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": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Check Run Re-Requested Event", + "description": "The check_run.rerequested webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "examples": { + "default": { + "value": { + "payload": "%7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/github-ae@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", + "externalDocs": { + "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "check_suite completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/github-ae@latest/rest/reference/checks#suites).", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ] + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_group", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "projects_v2_item", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "before": { + "type": [ + "string", + "null" + ] + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL that points to the check suite API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", + "url", + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "check_suite", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check-suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/github-ae@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/github-ae@latest/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/github-ae@latest/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", + "externalDocs": { + "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "check_suite requested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "actions_meta": { + "type": [ + "object", + "null" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/github-ae@latest/rest/reference/checks#suites).", + "type": "object", + "properties": { + "after": { + "type": [ + "string", + "null" + ] + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "secret_scanning_alert_location", + "projects_v2_item", + "merge_group", + "repository_import" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "before": { + "type": [ + "string", + "null" + ] + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": [ + "string", + "null" + ] + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": [ + "string", + "null" + ], + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL that points to the check suite API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", + "url", + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "check_suite", "repository", "sender" ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "check_run": { - "id": 128620228, - "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "external_id": "", - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", - "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", - "details_url": "https://octocoders.github.io", - "status": "queued", - "conclusion": null, - "started_at": "2019-05-15T15:21:12Z", - "completed_at": null, - "output": { - "title": null, - "summary": null, - "text": null, - "annotations_count": 0, - "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" - }, - "name": "Octocoders-linter", - "check_suite": { - "id": 118578147, - "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "head_branch": "changes", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "status": "queued", - "conclusion": null, - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", - "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ], - "deployment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", - "id": 326191728, - "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", - "task": "deploy", - "original_environment": "lab", - "environment": "lab", - "description": null, - "created_at": "2021-02-18T08:22:48Z", - "updated_at": "2021-02-18T09:47:16Z", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" - }, - "app": { - "id": 29310, - "node_id": "MDM6QXBwMjkzMTA=", - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "name": "octocoders-linter", - "description": "", - "external_url": "https://octocoders.github.io", - "html_url": "https://github.com/apps/octocoders-linter", - "created_at": "2019-04-19T19:36:24Z", - "updated_at": "2019-04-19T19:36:56Z", - "permissions": { - "administration": "write", - "checks": "write", - "contents": "write", - "deployments": "write", - "issues": "write", - "members": "write", - "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", - "pages": "write", - "pull_requests": "write", - "repository_hooks": "write", - "repository_projects": "write", - "statuses": "write", - "team_discussions": "write", - "vulnerability_alerts": "read" - }, - "events": [ - - ] - }, - "created_at": "2019-05-15T15:20:31Z", - "updated_at": "2019-05-15T15:20:31Z" - }, - "app": { - "id": 29310, - "node_id": "MDM6QXBwMjkzMTA=", - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "name": "octocoders-linter", - "description": "", - "external_url": "https://octocoders.github.io", - "html_url": "https://github.com/apps/octocoders-linter", - "created_at": "2019-04-19T19:36:24Z", - "updated_at": "2019-04-19T19:36:56Z", - "permissions": { - "administration": "write", - "checks": "write", - "contents": "write", - "deployments": "write", - "issues": "write", - "members": "write", - "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", - "pages": "write", - "pull_requests": "write", - "repository_hooks": "write", - "repository_projects": "write", - "statuses": "write", - "team_discussions": "write", - "vulnerability_alerts": "read" - }, - "events": [ - - ] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ] - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/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/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/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": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Check Run Created Event", - "description": "The check_run.created webhook encoded with URL encoding", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" - ] - }, - "examples": { - "default": { - "value": { - "payload": "%7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" - } - } } } } @@ -431226,9 +445477,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "check-suite", "supported-webhook-types": [ "repository", "organization", @@ -431237,11 +445487,11 @@ } } }, - "check-suite-completed": { + "check-suite-rerequested": { "post": { "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/github-ae@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/github-ae@latest/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/github-ae@latest/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { "url": "https://docs.github.com/github-ae@latest/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite" }, @@ -431308,20 +445558,36 @@ "content": { "application/json": { "schema": { - "title": "check_suite completed event", + "title": "check_suite rerequested event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "completed" + "rerequested" ] }, "actions_meta": { "type": [ "object", "null" - ] + ], + "properties": { + "rerun_info": { + "type": "object", + "properties": { + "plan_id": { + "type": "string" + }, + "job_ids": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } }, "check_suite": { "description": "The [check_suite](https://docs.github.com/github-ae@latest/rest/reference/checks#suites).", @@ -431402,13 +445668,9 @@ "watch", "workflow_dispatch", "workflow_run", - "merge_group", "pull_request_review_thread", - "workflow_job", "merge_queue_entry", - "security_and_analysis", - "projects_v2_item", - "secret_scanning_alert_location" + "workflow_job" ] } }, @@ -431821,7 +446083,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", "type": [ "string", "null" @@ -431834,9 +446096,7 @@ "timed_out", "action_required", "stale", - null, - "skipped", - "startup_failure" + null ] }, "created_at": { @@ -432065,8 +446325,7 @@ "in_progress", "completed", "queued", - null, - "pending" + null ] }, "updated_at": { @@ -890228,10 +904487,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -892346,10 +906612,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -894633,10 +908906,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", @@ -899058,10 +913338,17 @@ "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 + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, "url": { "type": "string", diff --git a/lib/webhooks/static/decorated/api.github.com.json b/lib/webhooks/static/decorated/api.github.com.json index 4fc376501bcb..936ef47bc2d3 100644 --- a/lib/webhooks/static/decorated/api.github.com.json +++ b/lib/webhooks/static/decorated/api.github.com.json @@ -5002,12 +5002,10 @@ ], "action": "created", "category": "check_run" - } - }, - "check_suite": { - "completed": { - "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", + }, + "requested_action": { + "descriptionHtml": "

A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -5016,29 +5014,17 @@ "description": "", "isRequired": true, "enum": [ - "completed" + "requested_action" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "actions_meta", - "in": "body", - "description": "" - }, { "type": "object", - "name": "check_suite", + "name": "check_run", "in": "body", - "description": "

The check_suite.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "", - "isRequired": true - }, { "type": "object", "name": "app", @@ -5046,45 +5032,15 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", + "type": "integer", "name": "id", "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", @@ -5093,19 +5049,14 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "owner", - "description": "", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -5115,590 +5066,1765 @@ }, { "type": "string", - "name": "events_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", + "type": "string or null", "name": "gravatar_id", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "following_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "organizations_url", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "received_events_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { "type": "boolean", "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "checks", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "metadata", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "contents", + "description": "" }, { "type": "string", - "name": "url", + "name": "deployments", "description": "" } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, { "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "administration", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, { "type": "string", - "name": "checks", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "content_references", + "name": "external_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "contents", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "deployments", + "name": "created_at", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "discussions", + "name": "updated_at", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "client_id", + "description": "" }, { "type": "string", - "name": "environments", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues", + "name": "url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] }, { - "type": "string", - "name": "keys", + "type": "object", + "name": "base", "description": "", - "enum": [ - "read", - "write" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "

Minimal Repository

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "members", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "metadata", + "name": "name", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_administration", + "name": "full_name", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "organization_hooks", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organization_packages", + "name": "url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_plan", + "name": "archive_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_projects", + "name": "assignees_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "organization_secrets", + "name": "blobs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_self_hosted_runners", + "name": "branches_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_user_blocking", + "name": "collaborators_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "packages", + "name": "comments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pages", + "name": "commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pull_requests", + "name": "compare_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_hooks", + "name": "contents_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_projects", + "name": "contributors_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "secret_scanning_alerts", + "name": "deployments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "secrets", + "name": "downloads_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_events", + "name": "events_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_scanning_alert", + "name": "forks_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "single_file", + "name": "git_commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "statuses", + "name": "git_refs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "team_discussions", + "name": "git_tags_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "vulnerability_alerts", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "workflows", + "name": "issue_events_url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" } ] }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] }, { - "type": "string or null", + "type": "string", "name": "updated_at", - "description": "", - "isRequired": true + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { "type": "string or null", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_runs_url", + "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", - "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "description": "", "isRequired": true, "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", "success", "failure", "neutral", "cancelled", + "skipped", "timed_out", "action_required", - "stale", - null, - "skipped", - "startup_failure" + null ] }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The head branch name the changes are on.

", - "isRequired": true - }, { "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "

Parameter to specify a task to execute

", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" + }, { "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, { "type": "string", "name": "name", - "description": "

The git author's name.

", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The git author's name.

", + "name": "updated_at", + "description": "", "isRequired": true }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "username", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true } ] }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, { "type": "string", "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", - "name": "latest_check_runs_count", - "description": "", + "name": "id", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { @@ -5707,15 +6833,71 @@ "description": "", "isRequired": true }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, { "type": "array of objects", "name": "pull_requests", - "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "description": "", "isRequired": true, "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "base", + "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5725,6 +6907,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5739,29 +6927,23 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] }, { "type": "object", - "name": "head", + "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5771,6 +6953,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5785,91 +6973,48 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true } ] }, { - "type": "boolean", - "name": "rerequestable", - "description": "" - }, - { - "type": "boolean", - "name": "runs_rerequestable", - "description": "" + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true }, { - "type": "string or null", + "type": "string", "name": "status", - "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "requested", + "queued", "in_progress", "completed", - "queued", - null, "pending" ] }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "

URL that points to the check suite API resource.

", + "description": "", "isRequired": true } ] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -5892,6 +7037,19 @@ "isRequired": true, "childParamsGroups": [] }, + { + "type": "object", + "name": "requested_action", + "in": "body", + "description": "

The action requested by the user.

", + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The integrator reference of the action requested by the user.

" + } + ] + }, { "type": "object", "name": "sender", @@ -5906,516 +7064,592 @@ "organization", "app" ], - "action": "completed", - "category": "check_suite" - } - }, - "code_scanning_alert": { - "appeared_in_branch": { - "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "requested_action", + "category": "check_run" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", - "isRequired": true, "enum": [ - "appeared_in_branch" + "rerequested" ], "childParamsGroups": [] }, { "type": "object", - "name": "alert", + "name": "check_run", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "events_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { "type": "string", - "name": "following_url", - "description": "" + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] }, { - "type": "string", - "name": "organizations_url", - "description": "" + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "client_id", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "client_secret", "description": "" }, { - "type": "string", - "name": "subscriptions_url", + "type": "string or null", + "name": "webhook_secret", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", + "name": "pem", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", + "type": "string or null", + "name": "after", "description": "" }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "path", + "name": "client_id", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "client_secret", "description": "" }, { - "type": "integer", - "name": "start_line", + "type": "string or null", + "name": "webhook_secret", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "pem", "description": "" } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true + "type": "string or null", + "name": "before", + "description": "" }, { "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, + "name": "conclusion", + "description": "", "enum": [ - "none", - "note", - "warning", - "error", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", null ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "appeared_in_branch", - "category": "code_scanning_alert" - }, - "closed_by_user": { - "descriptionHtml": "

Someone closed a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "name": "created_at", "description": "" }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", + "name": "head_branch", "description": "" }, { "type": "string", - "name": "html_url", - "description": "" + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", "description": "" }, { @@ -6424,1034 +7658,1416 @@ "description": "" }, { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", + "type": "array of objects", + "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] } ] }, { "type": "object", - "name": "message", - "description": "", + "name": "repository", + "description": "

Minimal Repository

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, + "name": "status", + "description": "", "enum": [ - "open", - "dismissed", - "fixed" + "queued", + "in_progress", + "completed", + "pending", + "waiting" ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "completed_at", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string or null", + "name": "conclusion", "description": "", "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ { "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true }, { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "task", + "description": "

Parameter to specify a task to execute

", "isRequired": true }, { "type": "string", - "name": "name", + "name": "original_environment", "description": "" }, { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string or null", - "name": "guid", - "description": "" + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed_by_user", - "category": "code_scanning_alert" - }, - "created": { - "descriptionHtml": "

A code scanning alert was created in a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_by", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "null", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "name": "statuses_url", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" }, { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" }, { "type": "object", - "name": "location", - "description": "", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { "type": "string", - "name": "text", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string", + "name": "details_url", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string", + "name": "external_id", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed" - ] + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", + "isRequired": true }, { - "type": "object or null", - "name": "tool", + "type": "string", + "name": "html_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "integer", + "name": "id", + "description": "

The id of the check.

", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "code_scanning_alert" - }, - "fixed": { - "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "fixed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "dismissed_by", + "type": "object", + "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", - "name": "id", + "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "annotations_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "string or null", + "name": "text", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", + "type": "array of objects", + "name": "pull_requests", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "url", + "description": "", "isRequired": true }, { "type": "object", - "name": "location", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] }, { "type": "object", - "name": "message", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", + "type": "string", + "name": "started_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "name": "status", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } + "queued", + "in_progress", + "completed", + "pending" ] }, { @@ -7462,20 +9078,6 @@ } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -7490,13 +9092,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -7519,12 +9114,14 @@ "organization", "app" ], - "action": "fixed", - "category": "code_scanning_alert" - }, - "reopened": { - "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "rerequested", + "category": "check_run" + } + }, + "check_suite": { + "completed": { + "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -7533,541 +9130,853 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "completed" ], "childParamsGroups": [] }, { "type": "object or null", - "name": "alert", + "name": "actions_meta", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "" + }, + { + "type": "object", + "name": "check_suite", + "in": "body", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", + "name": "after", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "array of strings", - "name": "classifications", - "description": "" + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "commit_sha", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "object", - "name": "location", + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "end_column", + "type": "string", + "name": "avatar_url", "description": "" }, { - "type": "integer", - "name": "end_line", + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "path", + "name": "events_url", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", "description": "" }, { "type": "integer", - "name": "start_line", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "node_id", "description": "" - } - ] - }, + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", "isRequired": true }, { "type": "object", - "name": "rule", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" + "name": "message", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "timestamp", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "tree_id", + "description": "", "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string or null", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "code_scanning_alert" - }, - "reopened_by_user": { - "descriptionHtml": "

Someone reopened a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "null", - "name": "dismissed_by", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "message", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] } ] }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "open", - "fixed" + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" ] }, { - "type": "object", - "name": "tool", + "type": "string", + "name": "updated_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "enterprise", @@ -8089,13 +9998,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -8118,301 +10020,862 @@ "organization", "app" ], - "action": "reopened_by_user", - "category": "code_scanning_alert" - } - }, - "commit_comment": { - "created": { - "descriptionHtml": "

Someone commented on a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "action": "completed", + "category": "check_suite" + }, + "requested": { + "descriptionHtml": "

Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", - "description": "

The action performed. Can be created.

", + "description": "", "isRequired": true, "enum": [ - "created" + "requested" ], "childParamsGroups": [] }, + { + "type": "object or null", + "name": "actions_meta", + "in": "body", + "description": "" + }, { "type": "object", - "name": "comment", + "name": "check_suite", "in": "body", - "description": "

The commit comment resource.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "

The text of the comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The ID of the commit comment.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the commit comment.

", - "isRequired": true - }, { "type": "string or null", - "name": "path", - "description": "

The relative path of the file to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "

The line index in the diff to which the comment applies.

", + "name": "after", + "description": "", "isRequired": true }, { "type": "object", - "name": "reactions", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "+1", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "integer", - "name": "eyes", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "laugh", - "description": "", + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "object or null", + "name": "owner", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "url", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "check_runs_url", "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, { "type": "string", - "name": "url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "user", + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "message", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" + "name": "timestamp", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" - }, + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "latest_check_runs_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "integer", + "name": "number", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "" + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", + "isRequired": true } ] }, @@ -8459,571 +10922,825 @@ "organization", "app" ], - "action": "created", - "category": "commit_comment" - } - }, - "create": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "action": "requested", + "category": "check_suite" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ - { - "type": "string or null", - "name": "description", - "in": "body", - "description": "

The repository's current description.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "master_branch", - "in": "body", - "description": "

The name of the repository's default branch (usually main).

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, { "type": "string", - "name": "ref_type", + "name": "action", "in": "body", - "description": "

The type of Git ref object created in the repository.

", + "description": "", "isRequired": true, "enum": [ - "tag", - "branch" - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "create" - } - }, - "delete": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", + "rerequested" + ], "childParamsGroups": [] }, { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref_type", + "type": "object or null", + "name": "actions_meta", "in": "body", - "description": "

The type of Git ref object deleted in the repository.

", - "isRequired": true, - "enum": [ - "tag", - "branch" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "rerun_info", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "plan_id", + "description": "" + }, + { + "type": "array of strings", + "name": "job_ids", + "description": "" + } + ] + } ] }, { "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "delete" - } - }, - "dependabot_alert": { - "created": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", + "name": "check_suite", "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "after", + "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] - }, { "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "html_url", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", + "type": "object or null", + "name": "owner", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ + "type": "string", + "name": "following_url", + "description": "" + }, { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", + "name": "login", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, { "type": "string", "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, + "description": "", "enum": [ - "CVE", - "GHSA" + "Bot", + "User", + "Organization" ] }, { "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "name": "url", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "updated_at", + "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "head_commit", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The unique package name within its ecosystem.

", + "description": "

The git author's name.

", "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" } ] }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } ] }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", + "type": "object", + "name": "head", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { "type": "integer", @@ -9032,20 +11749,8 @@ "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -9054,114 +11759,53 @@ "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, { "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", + "requested", + "in_progress", + "completed", + "queued", null ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9178,14 +11822,7 @@ }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", + "name": "repository", "in": "body", "description": "

A repository on GitHub.

", "isRequired": true, @@ -9205,12 +11842,14 @@ "organization", "app" ], - "action": "created", - "category": "dependabot_alert" - }, - "dismissed": { - "descriptionHtml": "

A Dependabot alert was manually closed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "action": "rerequested", + "category": "check_suite" + } + }, + "code_scanning_alert": { + "appeared_in_branch": { + "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9219,7 +11858,7 @@ "description": "", "isRequired": true, "enum": [ - "dismissed" + "appeared_in_branch" ], "childParamsGroups": [] }, @@ -9227,367 +11866,440 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "type": "object or null", + "name": "dismissed_by", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", "enum": [ - "development", - "runtime", - null + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array of object,nulls", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "type": "array of strings", + "name": "classifications", + "description": "" }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] } ] }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "tool", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "appeared_in_branch", + "category": "code_scanning_alert" + }, + "closed_by_user": { + "descriptionHtml": "

Someone closed a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", "name": "dismissed_at", "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -9597,147 +12309,337 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "dismissed", + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9753,11 +12655,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -9781,12 +12683,12 @@ "organization", "app" ], - "action": "dismissed", - "category": "dependabot_alert" + "action": "closed_by_user", + "category": "code_scanning_alert" }, - "fixed": { - "descriptionHtml": "

A manifest file change removed a vulnerability.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "created": { + "descriptionHtml": "

A code scanning alert was created in a repository.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9795,7 +12697,7 @@ "description": "", "isRequired": true, "enum": [ - "fixed" + "created" ], "childParamsGroups": [] }, @@ -9803,350 +12705,347 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

The dismissal comment associated with the dismissal of the alert.

" + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, + { + "type": "null", + "name": "fixed_at", + "description": "" + }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "array of strings", + "name": "classifications", + "description": "" }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "full_description", + "description": "" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "help", + "description": "" + }, { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed" + ] + }, + { + "type": "object or null", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true + "type": "string or null", + "name": "updated_at", + "description": "" }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "url", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "code_scanning_alert" + }, + "fixed": { + "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "fixed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { @@ -10156,14 +13055,19 @@ "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -10173,147 +13077,341 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10329,11 +13427,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -10358,11 +13456,11 @@ "app" ], "action": "fixed", - "category": "dependabot_alert" + "category": "code_scanning_alert" }, - "reintroduced": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "reopened": { + "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -10371,525 +13469,955 @@ "description": "", "isRequired": true, "enum": [ - "reintroduced" + "reopened" ], "childParamsGroups": [] }, { - "type": "object", + "type": "object or null", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "location", + "description": "", "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ { "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, "enum": [ - "development", - "runtime", - null + "open", + "dismissed", + "fixed" ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, + { + "type": "string", + "name": "full_description", + "description": "" + }, { "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "name": "help", + "description": "" }, { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] + "type": "string", + "name": "name", + "description": "" }, { - "type": "string", + "type": "string or null", "name": "severity", - "description": "

The severity of the advisory.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string or null", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "code_scanning_alert" + }, + "reopened_by_user": { + "descriptionHtml": "

Someone reopened a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] + "name": "path", + "description": "" }, { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] - }, + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened_by_user", + "category": "code_scanning_alert" + } + }, + "commit_comment": { + "created": { + "descriptionHtml": "

Someone commented on a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "

The action performed. Can be created.

", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "

The commit comment resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "

The text of the comment.

", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "commit_id", + "description": "

The SHA of the commit to which the comment applies.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

The ID of the commit comment.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "line", + "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node ID of the commit comment.

", "isRequired": true }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "path", + "description": "

The relative path of the file to which the comment applies.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "

The line index in the diff to which the comment applies.

", "isRequired": true }, { "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, + "name": "reactions", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "login", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "integer", + "name": "rocket", "description": "", "isRequired": true }, { - "type": "string", - "name": "html_url", + "type": "integer", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", + "name": "url", "description": "", "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", "name": "following_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "gists_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "organizations_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", "name": "received_events_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { "type": "boolean", "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "commit_comment" + } + }, + "create": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "bodyParameters": [ + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "

The repository's current description.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10897,6 +14425,13 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "master_branch", + "in": "body", + "description": "

The name of the repository's default branch (usually main).

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -10904,6 +14439,62 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object created in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "create" + } + }, + "delete": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", + "bodyParameters": [ { "type": "object", "name": "enterprise", @@ -10911,6 +14502,45 @@ "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object deleted in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, { "type": "object", "name": "repository", @@ -10933,11 +14563,13 @@ "organization", "app" ], - "action": "reintroduced", - "category": "dependabot_alert" - }, - "reopened": { - "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "action": "default", + "category": "delete" + } + }, + "dependabot_alert": { + "created": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -10947,7 +14579,7 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "created" ], "childParamsGroups": [] }, @@ -11509,14 +15141,12 @@ "organization", "app" ], - "action": "reopened", + "action": "created", "category": "dependabot_alert" - } - }, - "deploy_key": { - "created": { - "descriptionHtml": "

A deploy key was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + }, + "dismissed": { + "descriptionHtml": "

A Dependabot alert was manually closed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11525,207 +15155,532 @@ "description": "", "isRequired": true, "enum": [ - "created" + "dismissed" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", + "name": "alert", "in": "body", - "description": "

The deploy key resource.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "added_by", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "last_used", - "description": "" - }, - { - "type": "boolean", - "name": "read_only", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + }, + { + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] }, { - "type": "boolean", - "name": "verified", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "deploy_key" - }, - "deleted": { - "descriptionHtml": "

A deploy key was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", - "in": "body", - "description": "

The deploy key resource.

", - "isRequired": true, - "childParamsGroups": [ + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, { - "type": "string or null", - "name": "added_by", - "description": "" + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "created_at", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "key", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string or null", - "name": "last_used", - "description": "" + "type": "string", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "boolean", - "name": "read_only", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "title", - "description": "", - "isRequired": true + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "boolean", - "name": "verified", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -11733,6 +15688,13 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "repository", @@ -11755,14 +15717,12 @@ "organization", "app" ], - "action": "deleted", - "category": "deploy_key" - } - }, - "deployment": { - "created": { - "descriptionHtml": "

A deployment was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "action": "dismissed", + "category": "dependabot_alert" + }, + "fixed": { + "descriptionHtml": "

A manifest file change removed a vulnerability.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11771,204 +15731,415 @@ "description": "", "isRequired": true, "enum": [ - "created" + "fixed" ], "childParamsGroups": [] }, { "type": "object", - "name": "deployment", + "name": "alert", "in": "body", - "description": "

The deployment.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", + "type": "integer", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { - "type": "object or null", - "name": "creator", - "description": "", + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "environment", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "original_environment", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or string", - "name": "payload", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "created_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true }, { "type": "string or null", - "name": "external_url", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", "description": "", "isRequired": true }, @@ -11979,551 +16150,125 @@ "isRequired": true }, { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", + "type": "string", + "name": "followers_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", + "name": "following_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "gists_url", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "owner", + "type": "string", + "name": "starred_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "updated_at", + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" } ] }, { - "type": "boolean", - "name": "production_environment", - "description": "" - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "" + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] }, { - "type": "string", - "name": "updated_at", - "description": "", + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, { "type": "object", - "name": "enterprise", + "name": "installation", "in": "body", - "description": "

An enterprise on GitHub.

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { "type": "object", - "name": "installation", + "name": "organization", "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "description": "

A GitHub organization.

", "childParamsGroups": [] }, { "type": "object", - "name": "organization", + "name": "enterprise", "in": "body", - "description": "

A GitHub organization.

", + "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, { @@ -12541,1285 +16286,1243 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - }, + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "fixed", + "category": "dependabot_alert" + }, + "reintroduced": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ { - "type": "object or null", - "name": "workflow", + "type": "string", + "name": "action", "in": "body", "description": "", "isRequired": true, + "enum": [ + "reintroduced" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, { "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "check_suite_node_id", - "description": "", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, { "type": "string", "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "event", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "head_branch", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, - { - "type": "null", - "name": "head_commit", - "description": "" - }, { "type": "object", - "name": "head_repository", - "description": "", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "archive_url", + "type": "string or null", + "name": "name", "description": "" }, { - "type": "string", - "name": "assignees_url", + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "blobs_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "branches_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "collaborators_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commits_url", - "description": "" + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "compare_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contents_url", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "forks_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "full_name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_commits_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_refs_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_tags_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_comment_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "issues_url", - "description": "" + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", + "name": "starred_at", "description": "" - }, + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reintroduced", + "category": "dependabot_alert" + }, + "reopened": { + "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "

The security alert number.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "labels_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { - "type": "string", - "name": "merges_url", - "description": "" - }, + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "milestones_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "object", - "name": "owner", - "description": "", + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" - }, + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "repos_url", - "description": "" + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" - }, + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "starred_url", - "description": "" + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" - }, + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "type", - "description": "" + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] }, { "type": "string", - "name": "url", - "description": "" + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true } ] }, { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "statuses_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "subscribers_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "subscription_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "tags_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "teams_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "trees_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] } ] }, { "type": "string", - "name": "head_sha", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "path", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "name", + "description": "" }, { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "email", + "description": "" }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "integer", - "name": "number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "node_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "path", + "name": "avatar_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", + "type": "string or null", + "name": "gravatar_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "labels_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "merges_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "milestones_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", + "name": "type", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", + "name": "starred_at", "description": "" } ] }, { - "type": "string", - "name": "rerun_url", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "dependabot_alert" + } + }, + "deploy_key": { + "created": { + "descriptionHtml": "

A deploy key was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "added_by", "description": "" }, { - "type": "integer", - "name": "run_attempt", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "run_number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "run_started_at", + "name": "key", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "object or null", - "name": "triggering_actor", + "type": "boolean", + "name": "read_only", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "title", "description": "", "isRequired": true }, @@ -13830,17 +17533,35 @@ "isRequired": true }, { - "type": "integer", - "name": "workflow_id", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" } ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] } ], "availability": [ @@ -13849,13 +17570,11 @@ "app" ], "action": "created", - "category": "deployment" - } - }, - "deployment_status": { - "created": { - "descriptionHtml": "

A new deployment status was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "category": "deploy_key" + }, + "deleted": { + "descriptionHtml": "

A deploy key was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -13864,108 +17583,134 @@ "description": "", "isRequired": true, "enum": [ - "created" + "deleted" ], "childParamsGroups": [] }, { - "type": "object or null", - "name": "check_run", + "type": "object", + "name": "enterprise", "in": "body", - "description": "", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - "skipped", - null - ] + "name": "added_by", + "description": "" }, { "type": "string", - "name": "details_url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "external_id", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", + "name": "key", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The name of the check run.

", + "type": "boolean", + "name": "read_only", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { "type": "string", - "name": "started_at", + "name": "url", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "pending" - ] - }, - { - "type": "string", - "name": "url", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "deploy_key" + } + }, + "deployment": { + "created": { + "descriptionHtml": "

A deployment was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "deployment", @@ -14130,7 +17875,7 @@ "isRequired": true }, { - "type": "null or string or object", + "type": "object or string", "name": "payload", "description": "", "isRequired": true @@ -14696,718 +18441,6 @@ } ] }, - { - "type": "object", - "name": "deployment_status", - "in": "body", - "description": "

The deployment status.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "deployment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

The optional human-readable description added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "log_url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The new state. Can be pending, success, failure, or error.

", - "isRequired": true - }, - { - "type": "string", - "name": "target_url", - "description": "

The optional link added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "object", "name": "enterprise", @@ -15450,6 +18483,7 @@ "name": "workflow", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -15518,6 +18552,7 @@ "name": "workflow_run", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "object or null", @@ -15679,8 +18714,7 @@ "timed_out", "action_required", "stale", - null, - "startup_failure" + null ] }, { @@ -16604,7 +19638,6 @@ "type": "object or null", "name": "triggering_actor", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -16752,13 +19785,13 @@ "app" ], "action": "created", - "category": "deployment_status" + "category": "deployment" } }, - "discussion": { - "answered": { - "descriptionHtml": "

A comment on the discussion was marked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "deployment_status": { + "created": { + "descriptionHtml": "

A new deployment status was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -16767,55 +19800,55 @@ "description": "", "isRequired": true, "enum": [ - "answered" + "created" ], "childParamsGroups": [] }, { - "type": "object", - "name": "answer", + "type": "object or null", + "name": "check_run", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", "isRequired": true, "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + "skipped", + null ] }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", + "name": "details_url", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "external_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", - "description": "", + "type": "string", + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { @@ -16827,7 +19860,13 @@ { "type": "integer", "name": "id", - "description": "", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check run.

", "isRequired": true }, { @@ -16837,93 +19876,48 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "string", + "name": "started_at", "description": "", "isRequired": true }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } + "type": "string", + "name": "status", + "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "pending" ] }, { "type": "string", - "name": "repository_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "

The deployment.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "updated_at", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "user", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17040,113 +20034,145 @@ "description": "" } ] - } - ] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "answered", - "category": "discussion" - }, - "category_changed": { - "descriptionHtml": "

The category of a discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "category_changed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "category", + "type": "string or null", + "name": "description", "description": "", - "isRequired": true, + "isRequired": true + }, + { + "type": "string", + "name": "environment", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "", + "isRequired": true + }, + { + "type": "null or string or object", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "object", - "name": "from", + "type": "string or null", + "name": "created_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" }, { "type": "integer", @@ -17155,16 +20181,15 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", @@ -17172,51 +20197,457 @@ "description": "" }, { - "type": "integer", - "name": "repository_id", + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "slug", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] }, { "type": "string", - "name": "updated_at", + "name": "administration", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "production_environment", + "description": "" + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "discussion", + "name": "deployment_status", "in": "body", - "description": "", + "description": "

The deployment status.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "answer_chosen_by", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17334,118 +20765,28 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, { "type": "string", - "name": "body", + "name": "deployment_url", "description": "", "isRequired": true }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", + "type": "string", + "name": "description", + "description": "

The optional human-readable description added to the status.

", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "environment", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "environment_url", + "description": "" }, { "type": "integer", @@ -17454,10 +20795,9 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "string", + "name": "log_url", + "description": "" }, { "type": "string", @@ -17466,302 +20806,543 @@ "isRequired": true }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", "name": "name", - "description": "" + "description": "

The name of the GitHub app

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "object or null", + "name": "owner", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } ] }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "category_changed", - "category": "discussion" - }, - "created": { - "descriptionHtml": "

A discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The new state. Can be pending, success, failure, or error.

", + "isRequired": true + }, + { + "type": "string", + "name": "target_url", + "description": "

The optional link added to the status.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "object", @@ -17799,53 +21380,84 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "discussion" - }, - "deleted": { - "descriptionHtml": "

A discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] }, { - "type": "object", - "name": "discussion", + "type": "object or null", + "name": "workflow", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "badge_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "workflow_run", + "in": "body", + "description": "", + "childParamsGroups": [ { "type": "object or null", - "name": "answer_chosen_by", + "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17963,525 +21575,187 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "artifacts_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "name": "cancel_url", + "description": "" }, { "type": "integer", - "name": "comments", + "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "check_suite_url", + "description": "" }, { - "type": "boolean", - "name": "locked", + "type": "string or null", + "name": "conclusion", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" + ] }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "string", - "name": "repository_url", + "name": "display_title", "description": "", "isRequired": true }, { "type": "string", - "name": "state", + "name": "event", "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" + "isRequired": true }, { "type": "string", - "name": "title", + "name": "head_branch", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "null", + "name": "head_commit", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "object", + "name": "head_repository", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", + "name": "archive_url", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "assignees_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "blobs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "branches_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "collaborators_url", "description": "" }, { "type": "string", - "name": "html_url", + "name": "comments_url", "description": "" }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "name", + "name": "commits_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "compare_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "contents_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "contributors_url", "description": "" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "deployments_url", "description": "" }, { - "type": "string", - "name": "starred_url", + "type": "null", + "name": "description", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "downloads_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "discussion" - }, - "edited": { - "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", + "name": "events_url", "description": "" }, { "type": "boolean", - "name": "deleted", + "name": "fork", "description": "" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "forks_url", "description": "" }, { "type": "string", - "name": "events_url", + "name": "full_name", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "git_commits_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "git_refs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "git_tags_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "hooks_url", "description": "" }, { @@ -18492,124 +21766,366 @@ { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "name", + "name": "issue_comment_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "issue_events_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "issues_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "keys_url", "description": "" }, { "type": "string", - "name": "repos_url", + "name": "labels_url", "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "languages_url", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "merges_url", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "milestones_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "name", + "description": "" }, { "type": "string", - "name": "url", + "name": "node_id", "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "notifications_url", + "description": "" }, { - "type": "string", - "name": "emoji", + "type": "object", + "name": "owner", "description": "", - "isRequired": true - }, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "jobs_url", + "description": "" + }, + { + "type": "string", + "name": "logs_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "previous_attempt_url", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, { "type": "integer", "name": "id", @@ -18617,69 +22133,636 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects or null", + "name": "referenced_workflows", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "" + }, + { + "type": "string", + "name": "sha", "description": "", "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" }, { "type": "string", "name": "node_id", "description": "" }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "rerun_url", + "description": "" + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + { + "type": "object or null", + "name": "triggering_actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, { "type": "integer", - "name": "repository_id", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "slug", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "integer", - "name": "comments", + "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "workflow_url", + "description": "" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "deployment_status" + } + }, + "discussion": { + "answered": { + "descriptionHtml": "

A comment on the discussion was marked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "answered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "answer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "discussion_id", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, @@ -18690,8 +22773,8 @@ "isRequired": true }, { - "type": "integer", - "name": "number", + "type": "null", + "name": "parent_id", "description": "", "isRequired": true }, @@ -18768,29 +22851,6 @@ "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, { "type": "string", "name": "updated_at", @@ -18919,6 +22979,13 @@ } ] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "enterprise", @@ -18962,11 +23029,11 @@ "organization", "app" ], - "action": "edited", + "action": "answered", "category": "discussion" }, - "labeled": { - "descriptionHtml": "

A label was added to a discussion.

", + "category_changed": { + "descriptionHtml": "

The category of a discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -18976,10 +23043,94 @@ "description": "", "isRequired": true, "enum": [ - "labeled" + "category_changed" ], "childParamsGroups": [] }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, { "type": "object", "name": "discussion", @@ -19142,7 +23293,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -19496,58 +23647,7 @@ }, { "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", + "name": "organization", "in": "body", "description": "

A GitHub organization.

", "childParamsGroups": [] @@ -19574,11 +23674,11 @@ "organization", "app" ], - "action": "labeled", + "action": "category_changed", "category": "discussion" }, - "locked": { - "descriptionHtml": "

A discussion was locked.

", + "created": { + "descriptionHtml": "

A discussion was created.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19588,7 +23688,7 @@ "description": "", "isRequired": true, "enum": [ - "locked" + "created" ], "childParamsGroups": [] }, @@ -19642,11 +23742,11 @@ "organization", "app" ], - "action": "locked", + "action": "created", "category": "discussion" }, - "pinned": { - "descriptionHtml": "

A discussion was pinned.

", + "deleted": { + "descriptionHtml": "

A discussion was deleted.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19656,7 +23756,7 @@ "description": "", "isRequired": true, "enum": [ - "pinned" + "deleted" ], "childParamsGroups": [] }, @@ -20203,11 +24303,11 @@ "organization", "app" ], - "action": "pinned", + "action": "deleted", "category": "discussion" }, - "transferred": { - "descriptionHtml": "

A discussion was transferred to another repository.

", + "edited": { + "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -20217,7 +24317,7 @@ "description": "", "isRequired": true, "enum": [ - "transferred" + "edited" ], "childParamsGroups": [] }, @@ -20226,258 +24326,104 @@ "name": "changes", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "new_discussion", + "name": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "from", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "title", + "description": "", + "childParamsGroups": [ { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "from", "description": "", "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "name": "email", + "description": "" }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", @@ -20486,979 +24432,490 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "node_id", + "description": "" }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "name": "repos_url", + "description": "" }, { - "type": "string", - "name": "timeline_url", + "type": "boolean", + "name": "site_admin", "description": "" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "string", + "name": "type", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "new_repository", - "description": "

A git repository

", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, { "type": "string", - "name": "archive_url", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, { "type": "string", - "name": "assignees_url", + "name": "description", "description": "", "isRequired": true }, { "type": "string", - "name": "blobs_url", + "name": "emoji", "description": "", "isRequired": true }, { - "type": "string", - "name": "branches_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "clone_url", + "type": "boolean", + "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", - "name": "collaborators_url", + "name": "name", "description": "", "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { - "type": "string", - "name": "commits_url", + "type": "integer", + "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", - "name": "compare_url", + "name": "slug", "description": "", "isRequired": true }, { "type": "string", - "name": "contents_url", + "name": "updated_at", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ { - "type": "string", - "name": "contributors_url", + "type": "integer", + "name": "+1", "description": "", "isRequired": true }, { - "type": "integer or string", - "name": "created_at", + "type": "integer", + "name": "-1", "description": "", "isRequired": true }, { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "fork", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks", + "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks_count", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "forks_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "deleted", + "description": "" }, { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true + "name": "followers_url", + "description": "" }, { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", - "name": "issue_events_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true + "type": "string", + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "master_branch", + "name": "starred_url", "description": "" }, { "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { "type": "string", - "name": "milestones_url", + "name": "type", "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "discussion" + }, + "labeled": { + "descriptionHtml": "

A label was added to a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "labeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -21621,7 +25078,7 @@ ] }, { - "type": "string", + "type": "string or null", "name": "body", "description": "", "isRequired": true @@ -21973,6 +25430,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -22002,11 +25510,11 @@ "organization", "app" ], - "action": "transferred", + "action": "labeled", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "locked": { + "descriptionHtml": "

A discussion was locked.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22016,7 +25524,7 @@ "description": "", "isRequired": true, "enum": [ - "unanswered" + "locked" ], "childParamsGroups": [] }, @@ -22041,278 +25549,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "old_answer", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, { "type": "object", "name": "organization", @@ -22333,6 +25569,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -22341,11 +25578,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "locked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "

A label was removed from a discussion.

", + "pinned": { + "descriptionHtml": "

A discussion was pinned.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22355,7 +25592,7 @@ "description": "", "isRequired": true, "enum": [ - "unlabeled" + "pinned" ], "childParamsGroups": [] }, @@ -22873,125 +26110,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlabeled", - "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "

A discussion was unlocked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "unlocked" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, { "type": "object", "name": "organization", @@ -23021,11 +26139,11 @@ "organization", "app" ], - "action": "unlocked", + "action": "pinned", "category": "discussion" }, - "unpinned": { - "descriptionHtml": "

A discussion was unpinned.

", + "transferred": { + "descriptionHtml": "

A discussion was transferred to another repository.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -23035,852 +26153,1254 @@ "description": "", "isRequired": true, "enum": [ - "unpinned" + "transferred" ], "childParamsGroups": [] }, { "type": "object", - "name": "discussion", + "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", + "type": "object", + "name": "new_discussion", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "active_lock_reason", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "string or null", + "name": "answer_chosen_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", + "type": "object or null", + "name": "answer_chosen_by", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "created_at", + "type": "string or null", + "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "emoji", + "name": "body", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "slug", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", - "name": "confused", + "name": "number", "description": "", "isRequired": true }, { - "type": "integer", - "name": "eyes", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "state", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "timeline_url", + "description": "" }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "title", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "object or null", + "name": "user", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", + "type": "object", + "name": "new_repository", + "description": "

A git repository

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "allow_forking", + "description": "

Whether to allow private forks

" }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true }, { - "type": "string", - "name": "followers_url", + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", "description": "" }, { "type": "string", - "name": "following_url", - "description": "" + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "assignees_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "blobs_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" + "name": "branches_url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "comments_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "commits_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "compare_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "contents_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "contributors_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false }, { "type": "string", - "name": "type", + "name": "deployments_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unpinned", - "category": "discussion" - } - }, - "discussion_comment": { - "created": { - "descriptionHtml": "

A comment on a discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "events_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", + "type": "boolean", + "name": "fork", "description": "", "isRequired": true }, { "type": "integer", - "name": "eyes", + "name": "forks", "description": "", "isRequired": true }, { "type": "integer", - "name": "heart", + "name": "forks_count", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "forks_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "laugh", + "type": "string", + "name": "full_name", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "git_commits_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "git_tags_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "avatar_url", - "description": "" + "name": "git_url", + "description": "", + "isRequired": true }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "following_url", - "description": "" + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "boolean", + "name": "is_template", "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "issue_comment_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "issue_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "issues_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "labels_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true }, { "type": "string", - "name": "type", + "name": "languages_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", @@ -24037,7 +27557,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -24418,12 +27938,12 @@ "organization", "app" ], - "action": "created", - "category": "discussion_comment" + "action": "transferred", + "category": "discussion" }, - "deleted": { - "descriptionHtml": "

A comment on a discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unanswered": { + "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -24432,13 +27952,34 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "unanswered" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "comment", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "old_answer", "in": "body", "description": "", "isRequired": true, @@ -24502,7 +28043,7 @@ "isRequired": true }, { - "type": "integer or null", + "type": "null", "name": "parent_id", "description": "", "isRequired": true @@ -24511,7 +28052,6 @@ "type": "object", "name": "reactions", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "integer", @@ -24709,6 +28249,52 @@ } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unanswered", + "category": "discussion" + }, + "unlabeled": { + "descriptionHtml": "

A label was removed from a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -25223,6 +28809,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -25252,12 +28889,12 @@ "organization", "app" ], - "action": "deleted", - "category": "discussion_comment" + "action": "unlabeled", + "category": "discussion" }, - "edited": { - "descriptionHtml": "

A comment on a discussion was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unlocked": { + "descriptionHtml": "

A discussion was unlocked.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -25266,33 +28903,641 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "unlocked" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", - "name": "changes", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlocked", + "category": "discussion" + }, + "unpinned": { + "descriptionHtml": "

A discussion was unpinned.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unpinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", "name": "body", "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "from", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unpinned", + "category": "discussion" + } + }, + "discussion_comment": { + "created": { + "descriptionHtml": "

A comment on a discussion was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "comment", @@ -26109,74 +30354,12 @@ "organization", "app" ], - "action": "edited", + "action": "created", "category": "discussion_comment" - } - }, - "fork": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "forkee", - "in": "body", - "description": "

The created repository resource.

", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "default", - "category": "fork" - } - }, - "github_app_authorization": { - "revoked": { - "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + }, + "deleted": { + "descriptionHtml": "

A comment on a discussion was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26185,215 +30368,67 @@ "description": "", "isRequired": true, "enum": [ - "revoked" + "deleted" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "revoked", - "category": "github_app_authorization" - } - }, - "gollum": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "pages", + "name": "comment", "in": "body", - "description": "

The pages that were updated.

", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "action", - "description": "

The action that was performed on the page. Can be created or edited.

", + "name": "author_association", + "description": "

How the author is associated with the repository.

", "isRequired": true, "enum": [ - "created", - "edited" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, { "type": "string", - "name": "html_url", - "description": "

Points to the HTML wiki page.

", + "name": "body", + "description": "", "isRequired": true }, { - "type": "string", - "name": "page_name", - "description": "

The name of the page.

", + "type": "integer", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "sha", - "description": "

The latest commit SHA of the page.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "summary", + "type": "integer", + "name": "discussion_id", "description": "", "isRequired": true }, { "type": "string", - "name": "title", - "description": "

The current page title.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "gollum" - } - }, - "installation": { - "created": { - "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "description": "", "isRequired": true }, { @@ -26403,214 +30438,475 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requester", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "type": "integer or null", + "name": "parent_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "repository_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "type", + "name": "body", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } ] }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "created", - "category": "installation" - }, - "deleted": { - "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + "name": "created_at", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", + "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "type": "boolean", + "name": "locked", + "description": "", "isRequired": true }, { @@ -26620,159 +30916,235 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "deleted", - "category": "installation" - }, - "new_permissions_accepted": { - "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "new_permissions_accepted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", - "name": "full_name", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true + "name": "timeline_url", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "new_permissions_accepted", - "category": "installation" - }, - "suspend": { - "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "suspend" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "enterprise", @@ -26784,8 +31156,7 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", - "isRequired": true, + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { @@ -26795,57 +31166,14 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, { "type": "object", "name": "repository", "in": "body", "description": "

A repository on GitHub.

", + "isRequired": true, "childParamsGroups": [] }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, { "type": "object", "name": "sender", @@ -26856,14 +31184,16 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "suspend", - "category": "installation" + "action": "deleted", + "category": "discussion_comment" }, - "unsuspend": { - "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "edited": { + "descriptionHtml": "

A comment on a discussion was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26872,54 +31202,90 @@ "description": "", "isRequired": true, "enum": [ - "unsuspend" + "edited" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", + "name": "changes", "in": "body", - "description": "

Installation

", + "description": "", "isRequired": true, - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] }, { "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", + "name": "comment", "in": "body", - "description": "

An array of repository objects that the installation can access.

", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { @@ -26929,26 +31295,742 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer or null", + "name": "parent_id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, { "type": "object", "name": "sender", @@ -26959,16 +32041,78 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "unsuspend", - "category": "installation" + "action": "edited", + "category": "discussion_comment" } }, - "installation_repositories": { - "added": { - "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "fork": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "forkee", + "in": "body", + "description": "

The created repository resource.

", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "default", + "category": "fork" + } + }, + "github_app_authorization": { + "revoked": { + "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", "bodyParameters": [ { "type": "string", @@ -26977,7 +32121,7 @@ "description": "", "isRequired": true, "enum": [ - "added" + "revoked" ], "childParamsGroups": [] }, @@ -26992,9 +32136,57 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "revoked", + "category": "github_app_authorization" + } + }, + "gollum": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] }, { "type": "object", @@ -27005,74 +32197,152 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "pages", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", + "description": "

The pages that were updated.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "action", + "description": "

The action that was performed on the page. Can be created or edited.

", + "isRequired": true, + "enum": [ + "created", + "edited" + ] }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "type": "string", + "name": "html_url", + "description": "

Points to the HTML wiki page.

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "page_name", + "description": "

The name of the page.

", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "sha", + "description": "

The latest commit SHA of the page.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "title", + "description": "

The current page title.

", "isRequired": true } ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "gollum" + } + }, + "installation": { + "created": { + "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", "name": "full_name", - "description": "" + "description": "", + "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

" + "description": "

Unique identifier of the repository

", + "isRequired": true }, { "type": "string", "name": "name", - "description": "

The name of the repository.

" + "description": "

The name of the repository.

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "", + "isRequired": true }, { "type": "boolean", "name": "private", - "description": "

Whether the repository is private or public.

" + "description": "

Whether the repository is private or public.

", + "isRequired": true } ] }, @@ -27083,23 +32353,11 @@ "description": "

A repository on GitHub.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "repository_selection", - "in": "body", - "description": "

Describe whether all repositories have been selected or there's a selection involved

", - "isRequired": true, - "enum": [ - "all", - "selected" - ] - }, { "type": "object or null", "name": "requester", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -27227,12 +32485,12 @@ "availability": [ "app" ], - "action": "added", - "category": "installation_repositories" + "action": "created", + "category": "installation" }, - "removed": { - "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "deleted": { + "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -27241,7 +32499,7 @@ "description": "", "isRequired": true, "enum": [ - "removed" + "deleted" ], "childParamsGroups": [] }, @@ -27269,10 +32527,9 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "repositories", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", - "isRequired": true, + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", @@ -27307,20 +32564,699 @@ ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "deleted", + "category": "installation" + }, + "new_permissions_accepted": { + "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "new_permissions_accepted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "new_permissions_accepted", + "category": "installation" + }, + "suspend": { + "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "suspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "suspend", + "category": "installation" + }, + "unsuspend": { + "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unsuspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "unsuspend", + "category": "installation" + } + }, + "installation_repositories": { + "added": { + "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

" + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "

Describe whether all repositories have been selected or there's a selection involved

", + "isRequired": true, + "enum": [ + "all", + "selected" + ] + }, + { + "type": "object or null", + "name": "requester", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "added", + "category": "installation_repositories" + }, + "removed": { + "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", "name": "id", "description": "

Unique identifier of the repository

", "isRequired": true @@ -59770,166 +65706,3523 @@ }, { "type": "string", - "name": "organizations_url", - "description": "", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "deleted", + "category": "projects_v2_item" + }, + "edited": { + "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object or object", + "name": "changes", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2_item" + }, + "reordered": { + "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reordered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "previous_projects_v2_item_node_id", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "reordered", + "category": "projects_v2_item" + }, + "restored": { + "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "restored" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "archived_at", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "restored", + "category": "projects_v2_item" + } + }, + "public": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "public" + } + }, + "pull_request": { + "assigned": { + "descriptionHtml": "

A pull request was assigned to a user.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "

The status of auto merging a pull request.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "

Commit message for the merge commit.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "

Title for the merge commit message.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "

The merge method to use.

", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "

Indicates whether or not the pull request is a draft.

", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", "isRequired": true }, { - "type": "string", - "name": "repos_url", + "type": "boolean", + "name": "default", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "received_events_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "name", + "description": "

The name of the label.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_at", - "description": "" + "name": "url", + "description": "

URL for the label

", + "isRequired": true } ] }, { - "type": "string", - "name": "created_at", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "boolean", + "name": "maintainer_can_modify", + "description": "

Indicates whether maintainers can modify the pull request.

" }, { "type": "string or null", - "name": "archived_at", + "name": "merge_commit_sha", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "deleted", - "category": "projects_v2_item" - }, - "edited": { - "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object or object", - "name": "changes", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "number", - "name": "id", - "description": "", - "isRequired": true + "type": "boolean or null", + "name": "mergeable", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "mergeable_state", "description": "" }, { - "type": "string", - "name": "project_node_id", + "type": "boolean or null", + "name": "merged", "description": "" }, { - "type": "string", - "name": "content_node_id", + "type": "string or null", + "name": "merged_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "object or null", + "name": "merged_by", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -59939,298 +69232,257 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2_item" - }, - "reordered": { - "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reordered" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "previous_projects_v2_item_node_id", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", + "name": "url", "description": "" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "project_node_id", - "description": "" - }, - { - "type": "string", - "name": "content_node_id", - "description": "", - "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", "childParamsGroups": [ { "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", + "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "object or null", + "name": "creator", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "string or null", - "name": "gravatar_id", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "due_on", "description": "", "isRequired": true }, @@ -60241,217 +69493,312 @@ "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", + "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_url", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "", + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", "isRequired": true }, { - "type": "string", - "name": "organizations_url", + "type": "integer", + "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] }, { "type": "string", - "name": "events_url", - "description": "", + "name": "title", + "description": "

The title of the milestone.

", "isRequired": true }, { "type": "string", - "name": "received_events_url", + "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", + "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, { "type": "string", - "name": "created_at", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "integer", + "name": "number", + "description": "

Number uniquely identifying the pull request within its repository.

", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "patch_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "archived_at", + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reordered", - "category": "projects_v2_item" - }, - "restored": { - "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "restored" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "archived_at", + "type": "array of objects", + "name": "requested_teams", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "from", + "type": "boolean", + "name": "deleted", "description": "" }, { "type": "string or null", - "name": "to", + "name": "description", + "description": "

Description of the team

" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "

Description of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", "description": "" + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "review_comment_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "project_node_id", + "type": "integer", + "name": "review_comments", "description": "" }, { "type": "string", - "name": "content_node_id", + "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "name": "state", + "description": "

State of this Pull Request. Either open or closed.

", "isRequired": true, "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "open", + "closed" ] }, { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "

The title of the pull request.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -60461,181 +69808,106 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true } ] }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "restored", - "category": "projects_v2_item" - } - }, - "public": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, { "type": "object", "name": "repository", @@ -60658,13 +69930,11 @@ "organization", "app" ], - "action": "default", - "category": "public" - } - }, - "pull_request": { - "assigned": { - "descriptionHtml": "

A pull request was assigned to a user.

", + "action": "assigned", + "category": "pull_request" + }, + "auto_merge_disabled": { + "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -60674,131 +69944,10 @@ "description": "", "isRequired": true, "enum": [ - "assigned" + "auto_merge_disabled" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "assignee", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, { "type": "object", "name": "enterprise", @@ -60817,7 +69966,7 @@ "type": "integer", "name": "number", "in": "body", - "description": "

The pull request number.

", + "description": "", "isRequired": true }, { @@ -61082,8 +70231,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -61512,6 +70660,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "boolean", "name": "has_pages", @@ -61532,13 +70687,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "string or null", "name": "homepage", @@ -62255,7 +71403,7 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", + "type": "string", "name": "label", "description": "", "isRequired": true @@ -62267,7 +71415,7 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "repo", "description": "

A git repository

", "isRequired": true, @@ -63527,8 +72675,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -63972,6 +73119,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -63994,11 +73148,11 @@ "organization", "app" ], - "action": "assigned", + "action": "auto_merge_disabled", "category": "pull_request" }, - "auto_merge_disabled": { - "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "auto_merge_enabled": { + "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -64008,7 +73162,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_disabled" + "auto_merge_enabled" ], "childParamsGroups": [] }, @@ -64724,13 +73878,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "boolean", "name": "has_pages", @@ -64751,6 +73898,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "string or null", "name": "homepage", @@ -66739,7 +75893,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -67187,6 +76342,80 @@ "type": "string", "name": "reason", "in": "body", + "description": "" + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "auto_merge_enabled", + "category": "pull_request" + }, + "closed": { + "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, @@ -67212,11 +76441,11 @@ "organization", "app" ], - "action": "auto_merge_disabled", + "action": "closed", "category": "pull_request" }, - "auto_merge_enabled": { - "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "converted_to_draft": { + "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -67226,7 +76455,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_enabled" + "converted_to_draft" ], "childParamsGroups": [] }, @@ -67248,9 +76477,311 @@ "type": "integer", "name": "number", "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "converted_to_draft", + "category": "pull_request" + }, + "demilestoned": { + "descriptionHtml": "

A pull request was removed from a milestone.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "demilestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "

A collection of related issues and pull requests.

", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -67513,7 +77044,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -68455,7 +77987,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69437,7 +78969,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69813,7 +79345,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -70399,725 +79932,340 @@ "description": "" } ] - } - ] - }, - { - "type": "string", - "name": "reason", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_merge_enabled", - "category": "pull_request" - }, - "closed": { - "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "pull_request" - }, - "converted_to_draft": { - "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "converted_to_draft" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "converted_to_draft", - "category": "pull_request" - }, - "demilestoned": { - "descriptionHtml": "

A pull request was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "demilestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "in": "body", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "demilestoned", + "category": "pull_request" + }, + "dequeued": { + "descriptionHtml": "

A pull request was removed from the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "dequeued" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "array of object,nulls", @@ -72051,7 +81199,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73033,7 +82181,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73409,8 +82557,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -73999,6 +83146,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -74012,6 +83166,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -74020,7 +83175,7 @@ "organization", "app" ], - "action": "demilestoned", + "action": "dequeued", "category": "pull_request" }, "edited": { @@ -140108,9 +149263,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -140523,9 +149678,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141355,9 +150510,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141771,9 +150926,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", diff --git a/lib/webhooks/static/decorated/ghec.json b/lib/webhooks/static/decorated/ghec.json index e3294d620e2f..ee48fdd28ab3 100644 --- a/lib/webhooks/static/decorated/ghec.json +++ b/lib/webhooks/static/decorated/ghec.json @@ -5002,12 +5002,10 @@ ], "action": "created", "category": "check_run" - } - }, - "check_suite": { - "completed": { - "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", + }, + "requested_action": { + "descriptionHtml": "

A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -5016,29 +5014,17 @@ "description": "", "isRequired": true, "enum": [ - "completed" + "requested_action" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "actions_meta", - "in": "body", - "description": "" - }, { "type": "object", - "name": "check_suite", + "name": "check_run", "in": "body", - "description": "

The check_suite.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "", - "isRequired": true - }, { "type": "object", "name": "app", @@ -5046,45 +5032,15 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", + "type": "integer", "name": "id", "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", @@ -5093,19 +5049,14 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "owner", - "description": "", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -5115,590 +5066,1765 @@ }, { "type": "string", - "name": "events_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", + "type": "string or null", "name": "gravatar_id", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "following_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "organizations_url", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "received_events_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { "type": "boolean", "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "checks", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "metadata", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "contents", + "description": "" }, { "type": "string", - "name": "url", + "name": "deployments", "description": "" } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, { "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "administration", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, { "type": "string", - "name": "checks", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "content_references", + "name": "external_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "contents", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "deployments", + "name": "created_at", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "discussions", + "name": "updated_at", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "client_id", + "description": "" }, { "type": "string", - "name": "environments", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues", + "name": "url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] }, { - "type": "string", - "name": "keys", + "type": "object", + "name": "base", "description": "", - "enum": [ - "read", - "write" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "

Minimal Repository

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "members", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "metadata", + "name": "name", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_administration", + "name": "full_name", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "organization_hooks", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organization_packages", + "name": "url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_plan", + "name": "archive_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_projects", + "name": "assignees_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "organization_secrets", + "name": "blobs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_self_hosted_runners", + "name": "branches_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_user_blocking", + "name": "collaborators_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "packages", + "name": "comments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pages", + "name": "commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pull_requests", + "name": "compare_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_hooks", + "name": "contents_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_projects", + "name": "contributors_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "secret_scanning_alerts", + "name": "deployments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "secrets", + "name": "downloads_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_events", + "name": "events_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_scanning_alert", + "name": "forks_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "single_file", + "name": "git_commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "statuses", + "name": "git_refs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "team_discussions", + "name": "git_tags_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "vulnerability_alerts", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "workflows", + "name": "issue_events_url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" } ] }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] }, { - "type": "string or null", + "type": "string", "name": "updated_at", - "description": "", - "isRequired": true + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { "type": "string or null", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_runs_url", + "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", - "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "description": "", "isRequired": true, "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", "success", "failure", "neutral", "cancelled", + "skipped", "timed_out", "action_required", - "stale", - null, - "skipped", - "startup_failure" + null ] }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The head branch name the changes are on.

", - "isRequired": true - }, { "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "

Parameter to specify a task to execute

", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" + }, { "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, { "type": "string", "name": "name", - "description": "

The git author's name.

", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The git author's name.

", + "name": "updated_at", + "description": "", "isRequired": true }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "username", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true } ] }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, { "type": "string", "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", - "name": "latest_check_runs_count", - "description": "", + "name": "id", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { @@ -5707,15 +6833,71 @@ "description": "", "isRequired": true }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, { "type": "array of objects", "name": "pull_requests", - "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "description": "", "isRequired": true, "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "base", + "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5725,6 +6907,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5739,29 +6927,23 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] }, { "type": "object", - "name": "head", + "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5771,6 +6953,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5785,91 +6973,48 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true } ] }, { - "type": "boolean", - "name": "rerequestable", - "description": "" - }, - { - "type": "boolean", - "name": "runs_rerequestable", - "description": "" + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true }, { - "type": "string or null", + "type": "string", "name": "status", - "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "requested", + "queued", "in_progress", "completed", - "queued", - null, "pending" ] }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "

URL that points to the check suite API resource.

", + "description": "", "isRequired": true } ] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -5892,6 +7037,19 @@ "isRequired": true, "childParamsGroups": [] }, + { + "type": "object", + "name": "requested_action", + "in": "body", + "description": "

The action requested by the user.

", + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The integrator reference of the action requested by the user.

" + } + ] + }, { "type": "object", "name": "sender", @@ -5906,516 +7064,592 @@ "organization", "app" ], - "action": "completed", - "category": "check_suite" - } - }, - "code_scanning_alert": { - "appeared_in_branch": { - "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "requested_action", + "category": "check_run" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", - "isRequired": true, "enum": [ - "appeared_in_branch" + "rerequested" ], "childParamsGroups": [] }, { "type": "object", - "name": "alert", + "name": "check_run", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "events_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { "type": "string", - "name": "following_url", - "description": "" + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] }, { - "type": "string", - "name": "organizations_url", - "description": "" + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "client_id", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "client_secret", "description": "" }, { - "type": "string", - "name": "subscriptions_url", + "type": "string or null", + "name": "webhook_secret", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", + "name": "pem", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", + "type": "string or null", + "name": "after", "description": "" }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "path", + "name": "client_id", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "client_secret", "description": "" }, { - "type": "integer", - "name": "start_line", + "type": "string or null", + "name": "webhook_secret", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "pem", "description": "" } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true + "type": "string or null", + "name": "before", + "description": "" }, { "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, + "name": "conclusion", + "description": "", "enum": [ - "none", - "note", - "warning", - "error", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", null ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "appeared_in_branch", - "category": "code_scanning_alert" - }, - "closed_by_user": { - "descriptionHtml": "

Someone closed a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "name": "created_at", "description": "" }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", + "name": "head_branch", "description": "" }, { "type": "string", - "name": "html_url", - "description": "" + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", "description": "" }, { @@ -6424,1034 +7658,1416 @@ "description": "" }, { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", + "type": "array of objects", + "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] } ] }, { "type": "object", - "name": "message", - "description": "", + "name": "repository", + "description": "

Minimal Repository

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, + "name": "status", + "description": "", "enum": [ - "open", - "dismissed", - "fixed" + "queued", + "in_progress", + "completed", + "pending", + "waiting" ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "completed_at", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string or null", + "name": "conclusion", "description": "", "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ { "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true }, { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "task", + "description": "

Parameter to specify a task to execute

", "isRequired": true }, { "type": "string", - "name": "name", + "name": "original_environment", "description": "" }, { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string or null", - "name": "guid", - "description": "" + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed_by_user", - "category": "code_scanning_alert" - }, - "created": { - "descriptionHtml": "

A code scanning alert was created in a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_by", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "null", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "name": "statuses_url", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" }, { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" }, { "type": "object", - "name": "location", - "description": "", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { "type": "string", - "name": "text", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string", + "name": "details_url", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string", + "name": "external_id", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed" - ] + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", + "isRequired": true }, { - "type": "object or null", - "name": "tool", + "type": "string", + "name": "html_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "integer", + "name": "id", + "description": "

The id of the check.

", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "code_scanning_alert" - }, - "fixed": { - "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "fixed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "dismissed_by", + "type": "object", + "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", - "name": "id", + "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "annotations_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "string or null", + "name": "text", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", + "type": "array of objects", + "name": "pull_requests", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "url", + "description": "", "isRequired": true }, { "type": "object", - "name": "location", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] }, { "type": "object", - "name": "message", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", + "type": "string", + "name": "started_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "name": "status", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } + "queued", + "in_progress", + "completed", + "pending" ] }, { @@ -7462,20 +9078,6 @@ } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -7490,13 +9092,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -7519,12 +9114,14 @@ "organization", "app" ], - "action": "fixed", - "category": "code_scanning_alert" - }, - "reopened": { - "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "rerequested", + "category": "check_run" + } + }, + "check_suite": { + "completed": { + "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -7533,541 +9130,853 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "completed" ], "childParamsGroups": [] }, { "type": "object or null", - "name": "alert", + "name": "actions_meta", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "" + }, + { + "type": "object", + "name": "check_suite", + "in": "body", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", + "name": "after", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "array of strings", - "name": "classifications", - "description": "" + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "commit_sha", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "object", - "name": "location", + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "end_column", + "type": "string", + "name": "avatar_url", "description": "" }, { - "type": "integer", - "name": "end_line", + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "path", + "name": "events_url", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", "description": "" }, { "type": "integer", - "name": "start_line", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "node_id", "description": "" - } - ] - }, + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", "isRequired": true }, { "type": "object", - "name": "rule", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" + "name": "message", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "timestamp", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "tree_id", + "description": "", "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string or null", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "code_scanning_alert" - }, - "reopened_by_user": { - "descriptionHtml": "

Someone reopened a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "null", - "name": "dismissed_by", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "message", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] } ] }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "open", - "fixed" + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" ] }, { - "type": "object", - "name": "tool", + "type": "string", + "name": "updated_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "enterprise", @@ -8089,13 +9998,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -8118,301 +10020,862 @@ "organization", "app" ], - "action": "reopened_by_user", - "category": "code_scanning_alert" - } - }, - "commit_comment": { - "created": { - "descriptionHtml": "

Someone commented on a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "action": "completed", + "category": "check_suite" + }, + "requested": { + "descriptionHtml": "

Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", - "description": "

The action performed. Can be created.

", + "description": "", "isRequired": true, "enum": [ - "created" + "requested" ], "childParamsGroups": [] }, + { + "type": "object or null", + "name": "actions_meta", + "in": "body", + "description": "" + }, { "type": "object", - "name": "comment", + "name": "check_suite", "in": "body", - "description": "

The commit comment resource.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "

The text of the comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The ID of the commit comment.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the commit comment.

", - "isRequired": true - }, { "type": "string or null", - "name": "path", - "description": "

The relative path of the file to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "

The line index in the diff to which the comment applies.

", + "name": "after", + "description": "", "isRequired": true }, { "type": "object", - "name": "reactions", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "+1", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "integer", - "name": "eyes", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "laugh", - "description": "", + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "object or null", + "name": "owner", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "url", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "check_runs_url", "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, { "type": "string", - "name": "url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "user", + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "message", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" + "name": "timestamp", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" - }, + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "latest_check_runs_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "integer", + "name": "number", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "" + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", + "isRequired": true } ] }, @@ -8459,571 +10922,825 @@ "organization", "app" ], - "action": "created", - "category": "commit_comment" - } - }, - "create": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "action": "requested", + "category": "check_suite" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ - { - "type": "string or null", - "name": "description", - "in": "body", - "description": "

The repository's current description.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "master_branch", - "in": "body", - "description": "

The name of the repository's default branch (usually main).

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, { "type": "string", - "name": "ref_type", + "name": "action", "in": "body", - "description": "

The type of Git ref object created in the repository.

", + "description": "", "isRequired": true, "enum": [ - "tag", - "branch" - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "create" - } - }, - "delete": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", + "rerequested" + ], "childParamsGroups": [] }, { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref_type", + "type": "object or null", + "name": "actions_meta", "in": "body", - "description": "

The type of Git ref object deleted in the repository.

", - "isRequired": true, - "enum": [ - "tag", - "branch" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "rerun_info", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "plan_id", + "description": "" + }, + { + "type": "array of strings", + "name": "job_ids", + "description": "" + } + ] + } ] }, { "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "delete" - } - }, - "dependabot_alert": { - "created": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", + "name": "check_suite", "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "after", + "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] - }, { "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "html_url", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", + "type": "object or null", + "name": "owner", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ + "type": "string", + "name": "following_url", + "description": "" + }, { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", + "name": "login", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, { "type": "string", "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, + "description": "", "enum": [ - "CVE", - "GHSA" + "Bot", + "User", + "Organization" ] }, { "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "name": "url", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "updated_at", + "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "head_commit", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The unique package name within its ecosystem.

", + "description": "

The git author's name.

", "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" } ] }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } ] }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", + "type": "object", + "name": "head", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { "type": "integer", @@ -9032,20 +11749,8 @@ "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -9054,114 +11759,53 @@ "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, { "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", + "requested", + "in_progress", + "completed", + "queued", null ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9178,14 +11822,7 @@ }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", + "name": "repository", "in": "body", "description": "

A repository on GitHub.

", "isRequired": true, @@ -9205,12 +11842,14 @@ "organization", "app" ], - "action": "created", - "category": "dependabot_alert" - }, - "dismissed": { - "descriptionHtml": "

A Dependabot alert was manually closed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "action": "rerequested", + "category": "check_suite" + } + }, + "code_scanning_alert": { + "appeared_in_branch": { + "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9219,7 +11858,7 @@ "description": "", "isRequired": true, "enum": [ - "dismissed" + "appeared_in_branch" ], "childParamsGroups": [] }, @@ -9227,367 +11866,440 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "type": "object or null", + "name": "dismissed_by", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", "enum": [ - "development", - "runtime", - null + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array of object,nulls", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "type": "array of strings", + "name": "classifications", + "description": "" }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] } ] }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "tool", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "appeared_in_branch", + "category": "code_scanning_alert" + }, + "closed_by_user": { + "descriptionHtml": "

Someone closed a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", "name": "dismissed_at", "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -9597,147 +12309,337 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "dismissed", + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9753,11 +12655,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -9781,12 +12683,12 @@ "organization", "app" ], - "action": "dismissed", - "category": "dependabot_alert" + "action": "closed_by_user", + "category": "code_scanning_alert" }, - "fixed": { - "descriptionHtml": "

A manifest file change removed a vulnerability.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "created": { + "descriptionHtml": "

A code scanning alert was created in a repository.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9795,7 +12697,7 @@ "description": "", "isRequired": true, "enum": [ - "fixed" + "created" ], "childParamsGroups": [] }, @@ -9803,350 +12705,347 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

The dismissal comment associated with the dismissal of the alert.

" + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, + { + "type": "null", + "name": "fixed_at", + "description": "" + }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "array of strings", + "name": "classifications", + "description": "" }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "full_description", + "description": "" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "help", + "description": "" + }, { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed" + ] + }, + { + "type": "object or null", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true + "type": "string or null", + "name": "updated_at", + "description": "" }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "url", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "code_scanning_alert" + }, + "fixed": { + "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "fixed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { @@ -10156,14 +13055,19 @@ "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -10173,147 +13077,341 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10329,11 +13427,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -10358,11 +13456,11 @@ "app" ], "action": "fixed", - "category": "dependabot_alert" + "category": "code_scanning_alert" }, - "reintroduced": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "reopened": { + "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -10371,525 +13469,955 @@ "description": "", "isRequired": true, "enum": [ - "reintroduced" + "reopened" ], "childParamsGroups": [] }, { - "type": "object", + "type": "object or null", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "location", + "description": "", "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ { "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, "enum": [ - "development", - "runtime", - null + "open", + "dismissed", + "fixed" ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, + { + "type": "string", + "name": "full_description", + "description": "" + }, { "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "name": "help", + "description": "" }, { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] + "type": "string", + "name": "name", + "description": "" }, { - "type": "string", + "type": "string or null", "name": "severity", - "description": "

The severity of the advisory.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string or null", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "code_scanning_alert" + }, + "reopened_by_user": { + "descriptionHtml": "

Someone reopened a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] + "name": "path", + "description": "" }, { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] - }, + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened_by_user", + "category": "code_scanning_alert" + } + }, + "commit_comment": { + "created": { + "descriptionHtml": "

Someone commented on a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "

The action performed. Can be created.

", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "

The commit comment resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "

The text of the comment.

", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "commit_id", + "description": "

The SHA of the commit to which the comment applies.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

The ID of the commit comment.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "line", + "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node ID of the commit comment.

", "isRequired": true }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "path", + "description": "

The relative path of the file to which the comment applies.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "

The line index in the diff to which the comment applies.

", "isRequired": true }, { "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, + "name": "reactions", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "login", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "integer", + "name": "rocket", "description": "", "isRequired": true }, { - "type": "string", - "name": "html_url", + "type": "integer", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", + "name": "url", "description": "", "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", "name": "following_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "gists_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "organizations_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", "name": "received_events_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { "type": "boolean", "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "commit_comment" + } + }, + "create": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "bodyParameters": [ + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "

The repository's current description.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10897,6 +14425,13 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "master_branch", + "in": "body", + "description": "

The name of the repository's default branch (usually main).

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -10904,6 +14439,62 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object created in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "create" + } + }, + "delete": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", + "bodyParameters": [ { "type": "object", "name": "enterprise", @@ -10911,6 +14502,45 @@ "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object deleted in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, { "type": "object", "name": "repository", @@ -10933,11 +14563,13 @@ "organization", "app" ], - "action": "reintroduced", - "category": "dependabot_alert" - }, - "reopened": { - "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "action": "default", + "category": "delete" + } + }, + "dependabot_alert": { + "created": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -10947,7 +14579,7 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "created" ], "childParamsGroups": [] }, @@ -11509,14 +15141,12 @@ "organization", "app" ], - "action": "reopened", + "action": "created", "category": "dependabot_alert" - } - }, - "deploy_key": { - "created": { - "descriptionHtml": "

A deploy key was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + }, + "dismissed": { + "descriptionHtml": "

A Dependabot alert was manually closed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11525,207 +15155,532 @@ "description": "", "isRequired": true, "enum": [ - "created" + "dismissed" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", + "name": "alert", "in": "body", - "description": "

The deploy key resource.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "added_by", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "last_used", - "description": "" - }, - { - "type": "boolean", - "name": "read_only", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + }, + { + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] }, { - "type": "boolean", - "name": "verified", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "deploy_key" - }, - "deleted": { - "descriptionHtml": "

A deploy key was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", - "in": "body", - "description": "

The deploy key resource.

", - "isRequired": true, - "childParamsGroups": [ + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, { - "type": "string or null", - "name": "added_by", - "description": "" + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "created_at", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "key", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string or null", - "name": "last_used", - "description": "" + "type": "string", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "boolean", - "name": "read_only", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "title", - "description": "", - "isRequired": true + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "boolean", - "name": "verified", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -11733,6 +15688,13 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "repository", @@ -11755,14 +15717,12 @@ "organization", "app" ], - "action": "deleted", - "category": "deploy_key" - } - }, - "deployment": { - "created": { - "descriptionHtml": "

A deployment was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "action": "dismissed", + "category": "dependabot_alert" + }, + "fixed": { + "descriptionHtml": "

A manifest file change removed a vulnerability.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11771,204 +15731,415 @@ "description": "", "isRequired": true, "enum": [ - "created" + "fixed" ], "childParamsGroups": [] }, { "type": "object", - "name": "deployment", + "name": "alert", "in": "body", - "description": "

The deployment.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", + "type": "integer", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { - "type": "object or null", - "name": "creator", - "description": "", + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "environment", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "original_environment", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or string", - "name": "payload", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "created_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true }, { "type": "string or null", - "name": "external_url", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", "description": "", "isRequired": true }, @@ -11979,551 +16150,125 @@ "isRequired": true }, { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", + "type": "string", + "name": "followers_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", + "name": "following_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "gists_url", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "owner", + "type": "string", + "name": "starred_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "updated_at", + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" } ] }, { - "type": "boolean", - "name": "production_environment", - "description": "" - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "" + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] }, { - "type": "string", - "name": "updated_at", - "description": "", + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, { "type": "object", - "name": "enterprise", + "name": "installation", "in": "body", - "description": "

An enterprise on GitHub.

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { "type": "object", - "name": "installation", + "name": "organization", "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "description": "

A GitHub organization.

", "childParamsGroups": [] }, { "type": "object", - "name": "organization", + "name": "enterprise", "in": "body", - "description": "

A GitHub organization.

", + "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, { @@ -12541,1285 +16286,1243 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - }, + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "fixed", + "category": "dependabot_alert" + }, + "reintroduced": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ { - "type": "object or null", - "name": "workflow", + "type": "string", + "name": "action", "in": "body", "description": "", "isRequired": true, + "enum": [ + "reintroduced" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, { "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "check_suite_node_id", - "description": "", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, { "type": "string", "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "event", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "head_branch", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, - { - "type": "null", - "name": "head_commit", - "description": "" - }, { "type": "object", - "name": "head_repository", - "description": "", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "archive_url", + "type": "string or null", + "name": "name", "description": "" }, { - "type": "string", - "name": "assignees_url", + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "blobs_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "branches_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "collaborators_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commits_url", - "description": "" + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "compare_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contents_url", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "forks_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "full_name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_commits_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_refs_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_tags_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_comment_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "issues_url", - "description": "" + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", + "name": "starred_at", "description": "" - }, + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reintroduced", + "category": "dependabot_alert" + }, + "reopened": { + "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "

The security alert number.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "labels_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { - "type": "string", - "name": "merges_url", - "description": "" - }, + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "milestones_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "object", - "name": "owner", - "description": "", + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" - }, + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "repos_url", - "description": "" + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" - }, + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "starred_url", - "description": "" + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" - }, + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "type", - "description": "" + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] }, { "type": "string", - "name": "url", - "description": "" + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true } ] }, { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "statuses_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "subscribers_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "subscription_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "tags_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "teams_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "trees_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] } ] }, { "type": "string", - "name": "head_sha", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "path", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "name", + "description": "" }, { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "email", + "description": "" }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "integer", - "name": "number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "node_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "path", + "name": "avatar_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", + "type": "string or null", + "name": "gravatar_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "labels_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "merges_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "milestones_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", + "name": "type", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", + "name": "starred_at", "description": "" } ] }, { - "type": "string", - "name": "rerun_url", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "dependabot_alert" + } + }, + "deploy_key": { + "created": { + "descriptionHtml": "

A deploy key was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "added_by", "description": "" }, { - "type": "integer", - "name": "run_attempt", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "run_number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "run_started_at", + "name": "key", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "object or null", - "name": "triggering_actor", + "type": "boolean", + "name": "read_only", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "title", "description": "", "isRequired": true }, @@ -13830,17 +17533,35 @@ "isRequired": true }, { - "type": "integer", - "name": "workflow_id", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" } ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] } ], "availability": [ @@ -13849,13 +17570,11 @@ "app" ], "action": "created", - "category": "deployment" - } - }, - "deployment_status": { - "created": { - "descriptionHtml": "

A new deployment status was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "category": "deploy_key" + }, + "deleted": { + "descriptionHtml": "

A deploy key was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -13864,108 +17583,134 @@ "description": "", "isRequired": true, "enum": [ - "created" + "deleted" ], "childParamsGroups": [] }, { - "type": "object or null", - "name": "check_run", + "type": "object", + "name": "enterprise", "in": "body", - "description": "", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - "skipped", - null - ] + "name": "added_by", + "description": "" }, { "type": "string", - "name": "details_url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "external_id", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", + "name": "key", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The name of the check run.

", + "type": "boolean", + "name": "read_only", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { "type": "string", - "name": "started_at", + "name": "url", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "pending" - ] - }, - { - "type": "string", - "name": "url", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "deploy_key" + } + }, + "deployment": { + "created": { + "descriptionHtml": "

A deployment was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "deployment", @@ -14130,7 +17875,7 @@ "isRequired": true }, { - "type": "null or string or object", + "type": "object or string", "name": "payload", "description": "", "isRequired": true @@ -14696,718 +18441,6 @@ } ] }, - { - "type": "object", - "name": "deployment_status", - "in": "body", - "description": "

The deployment status.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "deployment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

The optional human-readable description added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "log_url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The new state. Can be pending, success, failure, or error.

", - "isRequired": true - }, - { - "type": "string", - "name": "target_url", - "description": "

The optional link added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "object", "name": "enterprise", @@ -15450,6 +18483,7 @@ "name": "workflow", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -15518,6 +18552,7 @@ "name": "workflow_run", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "object or null", @@ -15679,8 +18714,7 @@ "timed_out", "action_required", "stale", - null, - "startup_failure" + null ] }, { @@ -16604,7 +19638,6 @@ "type": "object or null", "name": "triggering_actor", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -16752,13 +19785,13 @@ "app" ], "action": "created", - "category": "deployment_status" + "category": "deployment" } }, - "discussion": { - "answered": { - "descriptionHtml": "

A comment on the discussion was marked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "deployment_status": { + "created": { + "descriptionHtml": "

A new deployment status was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -16767,55 +19800,55 @@ "description": "", "isRequired": true, "enum": [ - "answered" + "created" ], "childParamsGroups": [] }, { - "type": "object", - "name": "answer", + "type": "object or null", + "name": "check_run", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", "isRequired": true, "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + "skipped", + null ] }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", + "name": "details_url", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "external_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", - "description": "", + "type": "string", + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { @@ -16827,7 +19860,13 @@ { "type": "integer", "name": "id", - "description": "", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check run.

", "isRequired": true }, { @@ -16837,93 +19876,48 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "string", + "name": "started_at", "description": "", "isRequired": true }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } + "type": "string", + "name": "status", + "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "pending" ] }, { "type": "string", - "name": "repository_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "

The deployment.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "updated_at", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "user", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17040,113 +20034,145 @@ "description": "" } ] - } - ] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "answered", - "category": "discussion" - }, - "category_changed": { - "descriptionHtml": "

The category of a discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "category_changed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "category", + "type": "string or null", + "name": "description", "description": "", - "isRequired": true, + "isRequired": true + }, + { + "type": "string", + "name": "environment", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "", + "isRequired": true + }, + { + "type": "null or string or object", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "object", - "name": "from", + "type": "string or null", + "name": "created_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" }, { "type": "integer", @@ -17155,16 +20181,15 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", @@ -17172,51 +20197,457 @@ "description": "" }, { - "type": "integer", - "name": "repository_id", + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "slug", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] }, { "type": "string", - "name": "updated_at", + "name": "administration", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "production_environment", + "description": "" + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "discussion", + "name": "deployment_status", "in": "body", - "description": "", + "description": "

The deployment status.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "answer_chosen_by", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17334,118 +20765,28 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, { "type": "string", - "name": "body", + "name": "deployment_url", "description": "", "isRequired": true }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", + "type": "string", + "name": "description", + "description": "

The optional human-readable description added to the status.

", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "environment", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "environment_url", + "description": "" }, { "type": "integer", @@ -17454,10 +20795,9 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "string", + "name": "log_url", + "description": "" }, { "type": "string", @@ -17466,302 +20806,543 @@ "isRequired": true }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", "name": "name", - "description": "" + "description": "

The name of the GitHub app

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "object or null", + "name": "owner", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } ] }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "category_changed", - "category": "discussion" - }, - "created": { - "descriptionHtml": "

A discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The new state. Can be pending, success, failure, or error.

", + "isRequired": true + }, + { + "type": "string", + "name": "target_url", + "description": "

The optional link added to the status.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "object", @@ -17799,53 +21380,84 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "discussion" - }, - "deleted": { - "descriptionHtml": "

A discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] }, { - "type": "object", - "name": "discussion", + "type": "object or null", + "name": "workflow", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "badge_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "workflow_run", + "in": "body", + "description": "", + "childParamsGroups": [ { "type": "object or null", - "name": "answer_chosen_by", + "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17963,525 +21575,187 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "artifacts_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "name": "cancel_url", + "description": "" }, { "type": "integer", - "name": "comments", + "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "check_suite_url", + "description": "" }, { - "type": "boolean", - "name": "locked", + "type": "string or null", + "name": "conclusion", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" + ] }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "string", - "name": "repository_url", + "name": "display_title", "description": "", "isRequired": true }, { "type": "string", - "name": "state", + "name": "event", "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" + "isRequired": true }, { "type": "string", - "name": "title", + "name": "head_branch", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "null", + "name": "head_commit", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "object", + "name": "head_repository", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", + "name": "archive_url", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "assignees_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "blobs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "branches_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "collaborators_url", "description": "" }, { "type": "string", - "name": "html_url", + "name": "comments_url", "description": "" }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "name", + "name": "commits_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "compare_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "contents_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "contributors_url", "description": "" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "deployments_url", "description": "" }, { - "type": "string", - "name": "starred_url", + "type": "null", + "name": "description", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "downloads_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "discussion" - }, - "edited": { - "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", + "name": "events_url", "description": "" }, { "type": "boolean", - "name": "deleted", + "name": "fork", "description": "" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "forks_url", "description": "" }, { "type": "string", - "name": "events_url", + "name": "full_name", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "git_commits_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "git_refs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "git_tags_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "hooks_url", "description": "" }, { @@ -18492,124 +21766,366 @@ { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "name", + "name": "issue_comment_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "issue_events_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "issues_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "keys_url", "description": "" }, { "type": "string", - "name": "repos_url", + "name": "labels_url", "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "languages_url", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "merges_url", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "milestones_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "name", + "description": "" }, { "type": "string", - "name": "url", + "name": "node_id", "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "notifications_url", + "description": "" }, { - "type": "string", - "name": "emoji", + "type": "object", + "name": "owner", "description": "", - "isRequired": true - }, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "jobs_url", + "description": "" + }, + { + "type": "string", + "name": "logs_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "previous_attempt_url", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, { "type": "integer", "name": "id", @@ -18617,69 +22133,636 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects or null", + "name": "referenced_workflows", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "" + }, + { + "type": "string", + "name": "sha", "description": "", "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" }, { "type": "string", "name": "node_id", "description": "" }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "rerun_url", + "description": "" + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + { + "type": "object or null", + "name": "triggering_actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, { "type": "integer", - "name": "repository_id", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "slug", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "integer", - "name": "comments", + "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "workflow_url", + "description": "" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "deployment_status" + } + }, + "discussion": { + "answered": { + "descriptionHtml": "

A comment on the discussion was marked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "answered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "answer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "discussion_id", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, @@ -18690,8 +22773,8 @@ "isRequired": true }, { - "type": "integer", - "name": "number", + "type": "null", + "name": "parent_id", "description": "", "isRequired": true }, @@ -18768,29 +22851,6 @@ "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, { "type": "string", "name": "updated_at", @@ -18919,6 +22979,13 @@ } ] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "enterprise", @@ -18962,11 +23029,11 @@ "organization", "app" ], - "action": "edited", + "action": "answered", "category": "discussion" }, - "labeled": { - "descriptionHtml": "

A label was added to a discussion.

", + "category_changed": { + "descriptionHtml": "

The category of a discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -18976,10 +23043,94 @@ "description": "", "isRequired": true, "enum": [ - "labeled" + "category_changed" ], "childParamsGroups": [] }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, { "type": "object", "name": "discussion", @@ -19142,7 +23293,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -19496,58 +23647,7 @@ }, { "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", + "name": "organization", "in": "body", "description": "

A GitHub organization.

", "childParamsGroups": [] @@ -19574,11 +23674,11 @@ "organization", "app" ], - "action": "labeled", + "action": "category_changed", "category": "discussion" }, - "locked": { - "descriptionHtml": "

A discussion was locked.

", + "created": { + "descriptionHtml": "

A discussion was created.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19588,7 +23688,7 @@ "description": "", "isRequired": true, "enum": [ - "locked" + "created" ], "childParamsGroups": [] }, @@ -19642,11 +23742,11 @@ "organization", "app" ], - "action": "locked", + "action": "created", "category": "discussion" }, - "pinned": { - "descriptionHtml": "

A discussion was pinned.

", + "deleted": { + "descriptionHtml": "

A discussion was deleted.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19656,7 +23756,7 @@ "description": "", "isRequired": true, "enum": [ - "pinned" + "deleted" ], "childParamsGroups": [] }, @@ -20203,11 +24303,11 @@ "organization", "app" ], - "action": "pinned", + "action": "deleted", "category": "discussion" }, - "transferred": { - "descriptionHtml": "

A discussion was transferred to another repository.

", + "edited": { + "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -20217,7 +24317,7 @@ "description": "", "isRequired": true, "enum": [ - "transferred" + "edited" ], "childParamsGroups": [] }, @@ -20226,258 +24326,104 @@ "name": "changes", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "new_discussion", + "name": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "from", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "title", + "description": "", + "childParamsGroups": [ { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "from", "description": "", "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "name": "email", + "description": "" }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", @@ -20486,979 +24432,490 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "node_id", + "description": "" }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "name": "repos_url", + "description": "" }, { - "type": "string", - "name": "timeline_url", + "type": "boolean", + "name": "site_admin", "description": "" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "string", + "name": "type", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "new_repository", - "description": "

A git repository

", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, { "type": "string", - "name": "archive_url", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, { "type": "string", - "name": "assignees_url", + "name": "description", "description": "", "isRequired": true }, { "type": "string", - "name": "blobs_url", + "name": "emoji", "description": "", "isRequired": true }, { - "type": "string", - "name": "branches_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "clone_url", + "type": "boolean", + "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", - "name": "collaborators_url", + "name": "name", "description": "", "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { - "type": "string", - "name": "commits_url", + "type": "integer", + "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", - "name": "compare_url", + "name": "slug", "description": "", "isRequired": true }, { "type": "string", - "name": "contents_url", + "name": "updated_at", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ { - "type": "string", - "name": "contributors_url", + "type": "integer", + "name": "+1", "description": "", "isRequired": true }, { - "type": "integer or string", - "name": "created_at", + "type": "integer", + "name": "-1", "description": "", "isRequired": true }, { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "fork", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks", + "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks_count", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "forks_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "deleted", + "description": "" }, { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true + "name": "followers_url", + "description": "" }, { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", - "name": "issue_events_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true + "type": "string", + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "master_branch", + "name": "starred_url", "description": "" }, { "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { "type": "string", - "name": "milestones_url", + "name": "type", "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "discussion" + }, + "labeled": { + "descriptionHtml": "

A label was added to a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "labeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -21621,7 +25078,7 @@ ] }, { - "type": "string", + "type": "string or null", "name": "body", "description": "", "isRequired": true @@ -21973,6 +25430,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -22002,11 +25510,11 @@ "organization", "app" ], - "action": "transferred", + "action": "labeled", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "locked": { + "descriptionHtml": "

A discussion was locked.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22016,7 +25524,7 @@ "description": "", "isRequired": true, "enum": [ - "unanswered" + "locked" ], "childParamsGroups": [] }, @@ -22041,278 +25549,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "old_answer", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, { "type": "object", "name": "organization", @@ -22333,6 +25569,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -22341,11 +25578,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "locked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "

A label was removed from a discussion.

", + "pinned": { + "descriptionHtml": "

A discussion was pinned.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22355,7 +25592,7 @@ "description": "", "isRequired": true, "enum": [ - "unlabeled" + "pinned" ], "childParamsGroups": [] }, @@ -22873,125 +26110,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlabeled", - "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "

A discussion was unlocked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "unlocked" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, { "type": "object", "name": "organization", @@ -23021,11 +26139,11 @@ "organization", "app" ], - "action": "unlocked", + "action": "pinned", "category": "discussion" }, - "unpinned": { - "descriptionHtml": "

A discussion was unpinned.

", + "transferred": { + "descriptionHtml": "

A discussion was transferred to another repository.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -23035,852 +26153,1254 @@ "description": "", "isRequired": true, "enum": [ - "unpinned" + "transferred" ], "childParamsGroups": [] }, { "type": "object", - "name": "discussion", + "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", + "type": "object", + "name": "new_discussion", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "active_lock_reason", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "string or null", + "name": "answer_chosen_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", + "type": "object or null", + "name": "answer_chosen_by", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "created_at", + "type": "string or null", + "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "emoji", + "name": "body", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "slug", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", - "name": "confused", + "name": "number", "description": "", "isRequired": true }, { - "type": "integer", - "name": "eyes", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "state", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "timeline_url", + "description": "" }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "title", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "object or null", + "name": "user", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", + "type": "object", + "name": "new_repository", + "description": "

A git repository

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "allow_forking", + "description": "

Whether to allow private forks

" }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true }, { - "type": "string", - "name": "followers_url", + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", "description": "" }, { "type": "string", - "name": "following_url", - "description": "" + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "assignees_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "blobs_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" + "name": "branches_url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "comments_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "commits_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "compare_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "contents_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "contributors_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false }, { "type": "string", - "name": "type", + "name": "deployments_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unpinned", - "category": "discussion" - } - }, - "discussion_comment": { - "created": { - "descriptionHtml": "

A comment on a discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "events_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", + "type": "boolean", + "name": "fork", "description": "", "isRequired": true }, { "type": "integer", - "name": "eyes", + "name": "forks", "description": "", "isRequired": true }, { "type": "integer", - "name": "heart", + "name": "forks_count", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "forks_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "laugh", + "type": "string", + "name": "full_name", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "git_commits_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "git_tags_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "avatar_url", - "description": "" + "name": "git_url", + "description": "", + "isRequired": true }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "following_url", - "description": "" + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "boolean", + "name": "is_template", "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "issue_comment_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "issue_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "issues_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "labels_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true }, { "type": "string", - "name": "type", + "name": "languages_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", @@ -24037,7 +27557,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -24418,12 +27938,12 @@ "organization", "app" ], - "action": "created", - "category": "discussion_comment" + "action": "transferred", + "category": "discussion" }, - "deleted": { - "descriptionHtml": "

A comment on a discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unanswered": { + "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -24432,13 +27952,34 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "unanswered" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "comment", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "old_answer", "in": "body", "description": "", "isRequired": true, @@ -24502,7 +28043,7 @@ "isRequired": true }, { - "type": "integer or null", + "type": "null", "name": "parent_id", "description": "", "isRequired": true @@ -24511,7 +28052,6 @@ "type": "object", "name": "reactions", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "integer", @@ -24709,6 +28249,52 @@ } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unanswered", + "category": "discussion" + }, + "unlabeled": { + "descriptionHtml": "

A label was removed from a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -25223,6 +28809,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -25252,12 +28889,12 @@ "organization", "app" ], - "action": "deleted", - "category": "discussion_comment" + "action": "unlabeled", + "category": "discussion" }, - "edited": { - "descriptionHtml": "

A comment on a discussion was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unlocked": { + "descriptionHtml": "

A discussion was unlocked.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -25266,33 +28903,641 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "unlocked" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", - "name": "changes", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlocked", + "category": "discussion" + }, + "unpinned": { + "descriptionHtml": "

A discussion was unpinned.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unpinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", "name": "body", "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "from", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unpinned", + "category": "discussion" + } + }, + "discussion_comment": { + "created": { + "descriptionHtml": "

A comment on a discussion was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "comment", @@ -26109,74 +30354,12 @@ "organization", "app" ], - "action": "edited", + "action": "created", "category": "discussion_comment" - } - }, - "fork": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "forkee", - "in": "body", - "description": "

The created repository resource.

", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "default", - "category": "fork" - } - }, - "github_app_authorization": { - "revoked": { - "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + }, + "deleted": { + "descriptionHtml": "

A comment on a discussion was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26185,215 +30368,67 @@ "description": "", "isRequired": true, "enum": [ - "revoked" + "deleted" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "revoked", - "category": "github_app_authorization" - } - }, - "gollum": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "pages", + "name": "comment", "in": "body", - "description": "

The pages that were updated.

", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "action", - "description": "

The action that was performed on the page. Can be created or edited.

", + "name": "author_association", + "description": "

How the author is associated with the repository.

", "isRequired": true, "enum": [ - "created", - "edited" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, { "type": "string", - "name": "html_url", - "description": "

Points to the HTML wiki page.

", + "name": "body", + "description": "", "isRequired": true }, { - "type": "string", - "name": "page_name", - "description": "

The name of the page.

", + "type": "integer", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "sha", - "description": "

The latest commit SHA of the page.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "summary", + "type": "integer", + "name": "discussion_id", "description": "", "isRequired": true }, { "type": "string", - "name": "title", - "description": "

The current page title.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "gollum" - } - }, - "installation": { - "created": { - "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "description": "", "isRequired": true }, { @@ -26403,214 +30438,475 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requester", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "type": "integer or null", + "name": "parent_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "repository_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "type", + "name": "body", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } ] }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "created", - "category": "installation" - }, - "deleted": { - "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + "name": "created_at", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", + "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "type": "boolean", + "name": "locked", + "description": "", "isRequired": true }, { @@ -26620,159 +30916,235 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "deleted", - "category": "installation" - }, - "new_permissions_accepted": { - "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "new_permissions_accepted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", - "name": "full_name", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true + "name": "timeline_url", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "new_permissions_accepted", - "category": "installation" - }, - "suspend": { - "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "suspend" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "enterprise", @@ -26784,8 +31156,7 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", - "isRequired": true, + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { @@ -26795,57 +31166,14 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, { "type": "object", "name": "repository", "in": "body", "description": "

A repository on GitHub.

", + "isRequired": true, "childParamsGroups": [] }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, { "type": "object", "name": "sender", @@ -26856,14 +31184,16 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "suspend", - "category": "installation" + "action": "deleted", + "category": "discussion_comment" }, - "unsuspend": { - "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "edited": { + "descriptionHtml": "

A comment on a discussion was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26872,54 +31202,90 @@ "description": "", "isRequired": true, "enum": [ - "unsuspend" + "edited" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", + "name": "changes", "in": "body", - "description": "

Installation

", + "description": "", "isRequired": true, - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] }, { "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", + "name": "comment", "in": "body", - "description": "

An array of repository objects that the installation can access.

", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { @@ -26929,26 +31295,742 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer or null", + "name": "parent_id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, { "type": "object", "name": "sender", @@ -26959,16 +32041,78 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "unsuspend", - "category": "installation" + "action": "edited", + "category": "discussion_comment" } }, - "installation_repositories": { - "added": { - "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "fork": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "forkee", + "in": "body", + "description": "

The created repository resource.

", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "default", + "category": "fork" + } + }, + "github_app_authorization": { + "revoked": { + "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", "bodyParameters": [ { "type": "string", @@ -26977,7 +32121,7 @@ "description": "", "isRequired": true, "enum": [ - "added" + "revoked" ], "childParamsGroups": [] }, @@ -26992,9 +32136,57 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "revoked", + "category": "github_app_authorization" + } + }, + "gollum": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] }, { "type": "object", @@ -27005,74 +32197,152 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "pages", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", + "description": "

The pages that were updated.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "action", + "description": "

The action that was performed on the page. Can be created or edited.

", + "isRequired": true, + "enum": [ + "created", + "edited" + ] }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "type": "string", + "name": "html_url", + "description": "

Points to the HTML wiki page.

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "page_name", + "description": "

The name of the page.

", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "sha", + "description": "

The latest commit SHA of the page.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "title", + "description": "

The current page title.

", "isRequired": true } ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "gollum" + } + }, + "installation": { + "created": { + "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", "name": "full_name", - "description": "" + "description": "", + "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

" + "description": "

Unique identifier of the repository

", + "isRequired": true }, { "type": "string", "name": "name", - "description": "

The name of the repository.

" + "description": "

The name of the repository.

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "", + "isRequired": true }, { "type": "boolean", "name": "private", - "description": "

Whether the repository is private or public.

" + "description": "

Whether the repository is private or public.

", + "isRequired": true } ] }, @@ -27083,23 +32353,11 @@ "description": "

A repository on GitHub.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "repository_selection", - "in": "body", - "description": "

Describe whether all repositories have been selected or there's a selection involved

", - "isRequired": true, - "enum": [ - "all", - "selected" - ] - }, { "type": "object or null", "name": "requester", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -27227,12 +32485,12 @@ "availability": [ "app" ], - "action": "added", - "category": "installation_repositories" + "action": "created", + "category": "installation" }, - "removed": { - "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "deleted": { + "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -27241,7 +32499,7 @@ "description": "", "isRequired": true, "enum": [ - "removed" + "deleted" ], "childParamsGroups": [] }, @@ -27269,10 +32527,9 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "repositories", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", - "isRequired": true, + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", @@ -27307,20 +32564,699 @@ ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "deleted", + "category": "installation" + }, + "new_permissions_accepted": { + "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "new_permissions_accepted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "new_permissions_accepted", + "category": "installation" + }, + "suspend": { + "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "suspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "suspend", + "category": "installation" + }, + "unsuspend": { + "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unsuspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "unsuspend", + "category": "installation" + } + }, + "installation_repositories": { + "added": { + "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

" + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "

Describe whether all repositories have been selected or there's a selection involved

", + "isRequired": true, + "enum": [ + "all", + "selected" + ] + }, + { + "type": "object or null", + "name": "requester", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "added", + "category": "installation_repositories" + }, + "removed": { + "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", "name": "id", "description": "

Unique identifier of the repository

", "isRequired": true @@ -59770,166 +65706,3523 @@ }, { "type": "string", - "name": "organizations_url", - "description": "", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "deleted", + "category": "projects_v2_item" + }, + "edited": { + "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object or object", + "name": "changes", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2_item" + }, + "reordered": { + "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reordered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "previous_projects_v2_item_node_id", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "reordered", + "category": "projects_v2_item" + }, + "restored": { + "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "restored" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "archived_at", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "restored", + "category": "projects_v2_item" + } + }, + "public": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "public" + } + }, + "pull_request": { + "assigned": { + "descriptionHtml": "

A pull request was assigned to a user.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "

The status of auto merging a pull request.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "

Commit message for the merge commit.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "

Title for the merge commit message.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "

The merge method to use.

", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "

Indicates whether or not the pull request is a draft.

", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", "isRequired": true }, { - "type": "string", - "name": "repos_url", + "type": "boolean", + "name": "default", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "received_events_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "name", + "description": "

The name of the label.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_at", - "description": "" + "name": "url", + "description": "

URL for the label

", + "isRequired": true } ] }, { - "type": "string", - "name": "created_at", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "boolean", + "name": "maintainer_can_modify", + "description": "

Indicates whether maintainers can modify the pull request.

" }, { "type": "string or null", - "name": "archived_at", + "name": "merge_commit_sha", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "deleted", - "category": "projects_v2_item" - }, - "edited": { - "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object or object", - "name": "changes", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "number", - "name": "id", - "description": "", - "isRequired": true + "type": "boolean or null", + "name": "mergeable", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "mergeable_state", "description": "" }, { - "type": "string", - "name": "project_node_id", + "type": "boolean or null", + "name": "merged", "description": "" }, { - "type": "string", - "name": "content_node_id", + "type": "string or null", + "name": "merged_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "object or null", + "name": "merged_by", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -59939,298 +69232,257 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2_item" - }, - "reordered": { - "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reordered" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "previous_projects_v2_item_node_id", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", + "name": "url", "description": "" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "project_node_id", - "description": "" - }, - { - "type": "string", - "name": "content_node_id", - "description": "", - "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", "childParamsGroups": [ { "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", + "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "object or null", + "name": "creator", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "string or null", - "name": "gravatar_id", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "due_on", "description": "", "isRequired": true }, @@ -60241,217 +69493,312 @@ "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", + "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_url", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "", + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", "isRequired": true }, { - "type": "string", - "name": "organizations_url", + "type": "integer", + "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] }, { "type": "string", - "name": "events_url", - "description": "", + "name": "title", + "description": "

The title of the milestone.

", "isRequired": true }, { "type": "string", - "name": "received_events_url", + "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", + "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, { "type": "string", - "name": "created_at", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "integer", + "name": "number", + "description": "

Number uniquely identifying the pull request within its repository.

", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "patch_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "archived_at", + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reordered", - "category": "projects_v2_item" - }, - "restored": { - "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "restored" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "archived_at", + "type": "array of objects", + "name": "requested_teams", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "from", + "type": "boolean", + "name": "deleted", "description": "" }, { "type": "string or null", - "name": "to", + "name": "description", + "description": "

Description of the team

" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "

Description of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", "description": "" + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "review_comment_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "project_node_id", + "type": "integer", + "name": "review_comments", "description": "" }, { "type": "string", - "name": "content_node_id", + "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "name": "state", + "description": "

State of this Pull Request. Either open or closed.

", "isRequired": true, "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "open", + "closed" ] }, { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "

The title of the pull request.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -60461,181 +69808,106 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true } ] }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "restored", - "category": "projects_v2_item" - } - }, - "public": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, { "type": "object", "name": "repository", @@ -60658,13 +69930,11 @@ "organization", "app" ], - "action": "default", - "category": "public" - } - }, - "pull_request": { - "assigned": { - "descriptionHtml": "

A pull request was assigned to a user.

", + "action": "assigned", + "category": "pull_request" + }, + "auto_merge_disabled": { + "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -60674,131 +69944,10 @@ "description": "", "isRequired": true, "enum": [ - "assigned" + "auto_merge_disabled" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "assignee", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, { "type": "object", "name": "enterprise", @@ -60817,7 +69966,7 @@ "type": "integer", "name": "number", "in": "body", - "description": "

The pull request number.

", + "description": "", "isRequired": true }, { @@ -61082,8 +70231,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -61512,6 +70660,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "boolean", "name": "has_pages", @@ -61532,13 +70687,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "string or null", "name": "homepage", @@ -62255,7 +71403,7 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", + "type": "string", "name": "label", "description": "", "isRequired": true @@ -62267,7 +71415,7 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "repo", "description": "

A git repository

", "isRequired": true, @@ -63527,8 +72675,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -63972,6 +73119,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -63994,11 +73148,11 @@ "organization", "app" ], - "action": "assigned", + "action": "auto_merge_disabled", "category": "pull_request" }, - "auto_merge_disabled": { - "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "auto_merge_enabled": { + "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -64008,7 +73162,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_disabled" + "auto_merge_enabled" ], "childParamsGroups": [] }, @@ -64724,13 +73878,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "boolean", "name": "has_pages", @@ -64751,6 +73898,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "string or null", "name": "homepage", @@ -66739,7 +75893,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -67187,6 +76342,80 @@ "type": "string", "name": "reason", "in": "body", + "description": "" + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "auto_merge_enabled", + "category": "pull_request" + }, + "closed": { + "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, @@ -67212,11 +76441,11 @@ "organization", "app" ], - "action": "auto_merge_disabled", + "action": "closed", "category": "pull_request" }, - "auto_merge_enabled": { - "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "converted_to_draft": { + "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -67226,7 +76455,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_enabled" + "converted_to_draft" ], "childParamsGroups": [] }, @@ -67248,9 +76477,311 @@ "type": "integer", "name": "number", "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "converted_to_draft", + "category": "pull_request" + }, + "demilestoned": { + "descriptionHtml": "

A pull request was removed from a milestone.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "demilestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "

A collection of related issues and pull requests.

", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -67513,7 +77044,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -68455,7 +77987,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69437,7 +78969,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69813,7 +79345,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -70399,725 +79932,340 @@ "description": "" } ] - } - ] - }, - { - "type": "string", - "name": "reason", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_merge_enabled", - "category": "pull_request" - }, - "closed": { - "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "pull_request" - }, - "converted_to_draft": { - "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "converted_to_draft" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "converted_to_draft", - "category": "pull_request" - }, - "demilestoned": { - "descriptionHtml": "

A pull request was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "demilestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "in": "body", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "demilestoned", + "category": "pull_request" + }, + "dequeued": { + "descriptionHtml": "

A pull request was removed from the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "dequeued" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "array of object,nulls", @@ -72051,7 +81199,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73033,7 +82181,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73409,8 +82557,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -73999,6 +83146,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -74012,6 +83166,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -74020,7 +83175,7 @@ "organization", "app" ], - "action": "demilestoned", + "action": "dequeued", "category": "pull_request" }, "edited": { @@ -140108,9 +149263,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -140523,9 +149678,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141355,9 +150510,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141771,9 +150926,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", diff --git a/lib/webhooks/static/decorated/ghes-3.7.json b/lib/webhooks/static/decorated/ghes-3.7.json index 948e5cc6fb8d..6e8d856b7d4c 100644 --- a/lib/webhooks/static/decorated/ghes-3.7.json +++ b/lib/webhooks/static/decorated/ghes-3.7.json @@ -5002,12 +5002,10 @@ ], "action": "created", "category": "check_run" - } - }, - "check_suite": { - "completed": { - "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", + }, + "requested_action": { + "descriptionHtml": "

A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -5016,29 +5014,17 @@ "description": "", "isRequired": true, "enum": [ - "completed" + "requested_action" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "actions_meta", - "in": "body", - "description": "" - }, { "type": "object", - "name": "check_suite", + "name": "check_run", "in": "body", - "description": "

The check_suite.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "", - "isRequired": true - }, { "type": "object", "name": "app", @@ -5046,45 +5032,15 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", + "type": "integer", "name": "id", "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", @@ -5093,19 +5049,14 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "owner", - "description": "", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -5115,590 +5066,1765 @@ }, { "type": "string", - "name": "events_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", + "type": "string or null", "name": "gravatar_id", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "following_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "organizations_url", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "received_events_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { "type": "boolean", "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "checks", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "metadata", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "contents", + "description": "" }, { "type": "string", - "name": "url", + "name": "deployments", "description": "" } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, { "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "administration", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, { "type": "string", - "name": "checks", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "content_references", + "name": "external_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "contents", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "deployments", + "name": "created_at", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "discussions", + "name": "updated_at", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "client_id", + "description": "" }, { "type": "string", - "name": "environments", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues", + "name": "url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] }, { - "type": "string", - "name": "keys", + "type": "object", + "name": "base", "description": "", - "enum": [ - "read", - "write" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "

Minimal Repository

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "members", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "metadata", + "name": "name", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_administration", + "name": "full_name", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "organization_hooks", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organization_packages", + "name": "url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_plan", + "name": "archive_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_projects", + "name": "assignees_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "organization_secrets", + "name": "blobs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_self_hosted_runners", + "name": "branches_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_user_blocking", + "name": "collaborators_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "packages", + "name": "comments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pages", + "name": "commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pull_requests", + "name": "compare_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_hooks", + "name": "contents_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_projects", + "name": "contributors_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "secret_scanning_alerts", + "name": "deployments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "secrets", + "name": "downloads_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_events", + "name": "events_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_scanning_alert", + "name": "forks_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "single_file", + "name": "git_commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "statuses", + "name": "git_refs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "team_discussions", + "name": "git_tags_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "vulnerability_alerts", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "workflows", + "name": "issue_events_url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" } ] }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] }, { - "type": "string or null", + "type": "string", "name": "updated_at", - "description": "", - "isRequired": true + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { "type": "string or null", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_runs_url", + "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", - "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "description": "", "isRequired": true, "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", "success", "failure", "neutral", "cancelled", + "skipped", "timed_out", "action_required", - "stale", - null, - "skipped", - "startup_failure" + null ] }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The head branch name the changes are on.

", - "isRequired": true - }, { "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "

Parameter to specify a task to execute

", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" + }, { "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, { "type": "string", "name": "name", - "description": "

The git author's name.

", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The git author's name.

", + "name": "updated_at", + "description": "", "isRequired": true }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "username", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true } ] }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, { "type": "string", "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", - "name": "latest_check_runs_count", - "description": "", + "name": "id", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { @@ -5707,15 +6833,71 @@ "description": "", "isRequired": true }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, { "type": "array of objects", "name": "pull_requests", - "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "description": "", "isRequired": true, "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "base", + "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5725,6 +6907,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5739,29 +6927,23 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] }, { "type": "object", - "name": "head", + "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5771,6 +6953,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5785,91 +6973,48 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true } ] }, { - "type": "boolean", - "name": "rerequestable", - "description": "" - }, - { - "type": "boolean", - "name": "runs_rerequestable", - "description": "" + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true }, { - "type": "string or null", + "type": "string", "name": "status", - "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "requested", + "queued", "in_progress", "completed", - "queued", - null, "pending" ] }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "

URL that points to the check suite API resource.

", + "description": "", "isRequired": true } ] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -5892,6 +7037,19 @@ "isRequired": true, "childParamsGroups": [] }, + { + "type": "object", + "name": "requested_action", + "in": "body", + "description": "

The action requested by the user.

", + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The integrator reference of the action requested by the user.

" + } + ] + }, { "type": "object", "name": "sender", @@ -5906,516 +7064,592 @@ "organization", "app" ], - "action": "completed", - "category": "check_suite" - } - }, - "code_scanning_alert": { - "appeared_in_branch": { - "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "requested_action", + "category": "check_run" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", - "isRequired": true, "enum": [ - "appeared_in_branch" + "rerequested" ], "childParamsGroups": [] }, { "type": "object", - "name": "alert", + "name": "check_run", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "events_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { "type": "string", - "name": "following_url", - "description": "" + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] }, { - "type": "string", - "name": "organizations_url", - "description": "" + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "client_id", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "client_secret", "description": "" }, { - "type": "string", - "name": "subscriptions_url", + "type": "string or null", + "name": "webhook_secret", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", + "name": "pem", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", + "type": "string or null", + "name": "after", "description": "" }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "path", + "name": "client_id", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "client_secret", "description": "" }, { - "type": "integer", - "name": "start_line", + "type": "string or null", + "name": "webhook_secret", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "pem", "description": "" } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true + "type": "string or null", + "name": "before", + "description": "" }, { "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, + "name": "conclusion", + "description": "", "enum": [ - "none", - "note", - "warning", - "error", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", null ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "appeared_in_branch", - "category": "code_scanning_alert" - }, - "closed_by_user": { - "descriptionHtml": "

Someone closed a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "name": "created_at", "description": "" }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", + "name": "head_branch", "description": "" }, { "type": "string", - "name": "html_url", - "description": "" + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", "description": "" }, { @@ -6424,1034 +7658,1416 @@ "description": "" }, { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", + "type": "array of objects", + "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] } ] }, { "type": "object", - "name": "message", - "description": "", + "name": "repository", + "description": "

Minimal Repository

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, + "name": "status", + "description": "", "enum": [ - "open", - "dismissed", - "fixed" + "queued", + "in_progress", + "completed", + "pending", + "waiting" ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "completed_at", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string or null", + "name": "conclusion", "description": "", "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ { "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true }, { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "task", + "description": "

Parameter to specify a task to execute

", "isRequired": true }, { "type": "string", - "name": "name", + "name": "original_environment", "description": "" }, { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string or null", - "name": "guid", - "description": "" + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed_by_user", - "category": "code_scanning_alert" - }, - "created": { - "descriptionHtml": "

A code scanning alert was created in a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_by", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "null", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "name": "statuses_url", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" }, { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" }, { "type": "object", - "name": "location", - "description": "", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { "type": "string", - "name": "text", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string", + "name": "details_url", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string", + "name": "external_id", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed" - ] + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", + "isRequired": true }, { - "type": "object or null", - "name": "tool", + "type": "string", + "name": "html_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "integer", + "name": "id", + "description": "

The id of the check.

", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "code_scanning_alert" - }, - "fixed": { - "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "fixed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "dismissed_by", + "type": "object", + "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", - "name": "id", + "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "annotations_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "string or null", + "name": "text", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", + "type": "array of objects", + "name": "pull_requests", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "url", + "description": "", "isRequired": true }, { "type": "object", - "name": "location", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] }, { "type": "object", - "name": "message", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", + "type": "string", + "name": "started_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "name": "status", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } + "queued", + "in_progress", + "completed", + "pending" ] }, { @@ -7462,20 +9078,6 @@ } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -7490,13 +9092,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -7519,12 +9114,14 @@ "organization", "app" ], - "action": "fixed", - "category": "code_scanning_alert" - }, - "reopened": { - "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "rerequested", + "category": "check_run" + } + }, + "check_suite": { + "completed": { + "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -7533,541 +9130,853 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "completed" ], "childParamsGroups": [] }, { "type": "object or null", - "name": "alert", + "name": "actions_meta", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "" + }, + { + "type": "object", + "name": "check_suite", + "in": "body", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", + "name": "after", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "array of strings", - "name": "classifications", - "description": "" + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "commit_sha", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "object", - "name": "location", + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "end_column", + "type": "string", + "name": "avatar_url", "description": "" }, { - "type": "integer", - "name": "end_line", + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "path", + "name": "events_url", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", "description": "" }, { "type": "integer", - "name": "start_line", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "node_id", "description": "" - } - ] - }, + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", "isRequired": true }, { "type": "object", - "name": "rule", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" + "name": "message", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "timestamp", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "tree_id", + "description": "", "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string or null", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "code_scanning_alert" - }, - "reopened_by_user": { - "descriptionHtml": "

Someone reopened a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "null", - "name": "dismissed_by", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "message", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] } ] }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "open", - "fixed" + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" ] }, { - "type": "object", - "name": "tool", + "type": "string", + "name": "updated_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "enterprise", @@ -8089,13 +9998,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -8118,301 +10020,862 @@ "organization", "app" ], - "action": "reopened_by_user", - "category": "code_scanning_alert" - } - }, - "commit_comment": { - "created": { - "descriptionHtml": "

Someone commented on a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "action": "completed", + "category": "check_suite" + }, + "requested": { + "descriptionHtml": "

Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", - "description": "

The action performed. Can be created.

", + "description": "", "isRequired": true, "enum": [ - "created" + "requested" ], "childParamsGroups": [] }, + { + "type": "object or null", + "name": "actions_meta", + "in": "body", + "description": "" + }, { "type": "object", - "name": "comment", + "name": "check_suite", "in": "body", - "description": "

The commit comment resource.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "

The text of the comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The ID of the commit comment.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the commit comment.

", - "isRequired": true - }, { "type": "string or null", - "name": "path", - "description": "

The relative path of the file to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "

The line index in the diff to which the comment applies.

", + "name": "after", + "description": "", "isRequired": true }, { "type": "object", - "name": "reactions", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "+1", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "integer", - "name": "eyes", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "laugh", - "description": "", + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "object or null", + "name": "owner", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "url", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "check_runs_url", "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, { "type": "string", - "name": "url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "user", + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "message", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" + "name": "timestamp", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" - }, + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "latest_check_runs_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "integer", + "name": "number", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "" + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", + "isRequired": true } ] }, @@ -8459,571 +10922,825 @@ "organization", "app" ], - "action": "created", - "category": "commit_comment" - } - }, - "create": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "action": "requested", + "category": "check_suite" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ - { - "type": "string or null", - "name": "description", - "in": "body", - "description": "

The repository's current description.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "master_branch", - "in": "body", - "description": "

The name of the repository's default branch (usually main).

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, { "type": "string", - "name": "ref_type", + "name": "action", "in": "body", - "description": "

The type of Git ref object created in the repository.

", + "description": "", "isRequired": true, "enum": [ - "tag", - "branch" - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "create" - } - }, - "delete": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", + "rerequested" + ], "childParamsGroups": [] }, { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref_type", + "type": "object or null", + "name": "actions_meta", "in": "body", - "description": "

The type of Git ref object deleted in the repository.

", - "isRequired": true, - "enum": [ - "tag", - "branch" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "rerun_info", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "plan_id", + "description": "" + }, + { + "type": "array of strings", + "name": "job_ids", + "description": "" + } + ] + } ] }, { "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "delete" - } - }, - "dependabot_alert": { - "created": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", + "name": "check_suite", "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "after", + "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] - }, { "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "html_url", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", + "type": "object or null", + "name": "owner", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ + "type": "string", + "name": "following_url", + "description": "" + }, { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", + "name": "login", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, { "type": "string", "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, + "description": "", "enum": [ - "CVE", - "GHSA" + "Bot", + "User", + "Organization" ] }, { "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "name": "url", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "updated_at", + "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "head_commit", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The unique package name within its ecosystem.

", + "description": "

The git author's name.

", "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" } ] }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } ] }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", + "type": "object", + "name": "head", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { "type": "integer", @@ -9032,20 +11749,8 @@ "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -9054,114 +11759,53 @@ "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, { "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", + "requested", + "in_progress", + "completed", + "queued", null ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9178,14 +11822,7 @@ }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", + "name": "repository", "in": "body", "description": "

A repository on GitHub.

", "isRequired": true, @@ -9205,12 +11842,14 @@ "organization", "app" ], - "action": "created", - "category": "dependabot_alert" - }, - "dismissed": { - "descriptionHtml": "

A Dependabot alert was manually closed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "action": "rerequested", + "category": "check_suite" + } + }, + "code_scanning_alert": { + "appeared_in_branch": { + "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9219,7 +11858,7 @@ "description": "", "isRequired": true, "enum": [ - "dismissed" + "appeared_in_branch" ], "childParamsGroups": [] }, @@ -9227,367 +11866,440 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "type": "object or null", + "name": "dismissed_by", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", "enum": [ - "development", - "runtime", - null + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array of object,nulls", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "type": "array of strings", + "name": "classifications", + "description": "" }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] } ] }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "tool", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "appeared_in_branch", + "category": "code_scanning_alert" + }, + "closed_by_user": { + "descriptionHtml": "

Someone closed a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", "name": "dismissed_at", "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -9597,147 +12309,337 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "dismissed", + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9753,11 +12655,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -9781,12 +12683,12 @@ "organization", "app" ], - "action": "dismissed", - "category": "dependabot_alert" + "action": "closed_by_user", + "category": "code_scanning_alert" }, - "fixed": { - "descriptionHtml": "

A manifest file change removed a vulnerability.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "created": { + "descriptionHtml": "

A code scanning alert was created in a repository.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9795,7 +12697,7 @@ "description": "", "isRequired": true, "enum": [ - "fixed" + "created" ], "childParamsGroups": [] }, @@ -9803,350 +12705,347 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

The dismissal comment associated with the dismissal of the alert.

" + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, + { + "type": "null", + "name": "fixed_at", + "description": "" + }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "array of strings", + "name": "classifications", + "description": "" }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "full_description", + "description": "" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "help", + "description": "" + }, { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed" + ] + }, + { + "type": "object or null", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true + "type": "string or null", + "name": "updated_at", + "description": "" }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "url", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "code_scanning_alert" + }, + "fixed": { + "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "fixed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { @@ -10156,14 +13055,19 @@ "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -10173,147 +13077,341 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10329,11 +13427,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -10358,11 +13456,11 @@ "app" ], "action": "fixed", - "category": "dependabot_alert" + "category": "code_scanning_alert" }, - "reintroduced": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "reopened": { + "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -10371,525 +13469,955 @@ "description": "", "isRequired": true, "enum": [ - "reintroduced" + "reopened" ], "childParamsGroups": [] }, { - "type": "object", + "type": "object or null", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "location", + "description": "", "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ { "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, "enum": [ - "development", - "runtime", - null + "open", + "dismissed", + "fixed" ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, + { + "type": "string", + "name": "full_description", + "description": "" + }, { "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "name": "help", + "description": "" }, { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] + "type": "string", + "name": "name", + "description": "" }, { - "type": "string", + "type": "string or null", "name": "severity", - "description": "

The severity of the advisory.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string or null", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "code_scanning_alert" + }, + "reopened_by_user": { + "descriptionHtml": "

Someone reopened a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] + "name": "path", + "description": "" }, { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] - }, + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened_by_user", + "category": "code_scanning_alert" + } + }, + "commit_comment": { + "created": { + "descriptionHtml": "

Someone commented on a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "

The action performed. Can be created.

", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "

The commit comment resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "

The text of the comment.

", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "commit_id", + "description": "

The SHA of the commit to which the comment applies.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

The ID of the commit comment.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "line", + "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node ID of the commit comment.

", "isRequired": true }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "path", + "description": "

The relative path of the file to which the comment applies.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "

The line index in the diff to which the comment applies.

", "isRequired": true }, { "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, + "name": "reactions", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "login", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "integer", + "name": "rocket", "description": "", "isRequired": true }, { - "type": "string", - "name": "html_url", + "type": "integer", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", + "name": "url", "description": "", "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", "name": "following_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "gists_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "organizations_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", "name": "received_events_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { "type": "boolean", "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "commit_comment" + } + }, + "create": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "bodyParameters": [ + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "

The repository's current description.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10897,6 +14425,13 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "master_branch", + "in": "body", + "description": "

The name of the repository's default branch (usually main).

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -10904,6 +14439,62 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object created in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "create" + } + }, + "delete": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", + "bodyParameters": [ { "type": "object", "name": "enterprise", @@ -10911,6 +14502,45 @@ "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object deleted in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, { "type": "object", "name": "repository", @@ -10933,11 +14563,13 @@ "organization", "app" ], - "action": "reintroduced", - "category": "dependabot_alert" - }, - "reopened": { - "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "action": "default", + "category": "delete" + } + }, + "dependabot_alert": { + "created": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -10947,7 +14579,7 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "created" ], "childParamsGroups": [] }, @@ -11509,14 +15141,12 @@ "organization", "app" ], - "action": "reopened", + "action": "created", "category": "dependabot_alert" - } - }, - "deploy_key": { - "created": { - "descriptionHtml": "

A deploy key was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + }, + "dismissed": { + "descriptionHtml": "

A Dependabot alert was manually closed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11525,207 +15155,532 @@ "description": "", "isRequired": true, "enum": [ - "created" + "dismissed" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", + "name": "alert", "in": "body", - "description": "

The deploy key resource.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "added_by", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "last_used", - "description": "" - }, - { - "type": "boolean", - "name": "read_only", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + }, + { + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] }, { - "type": "boolean", - "name": "verified", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "deploy_key" - }, - "deleted": { - "descriptionHtml": "

A deploy key was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", - "in": "body", - "description": "

The deploy key resource.

", - "isRequired": true, - "childParamsGroups": [ + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, { - "type": "string or null", - "name": "added_by", - "description": "" + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "created_at", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "key", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string or null", - "name": "last_used", - "description": "" + "type": "string", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "boolean", - "name": "read_only", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "title", - "description": "", - "isRequired": true + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "boolean", - "name": "verified", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -11733,6 +15688,13 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "repository", @@ -11755,14 +15717,12 @@ "organization", "app" ], - "action": "deleted", - "category": "deploy_key" - } - }, - "deployment": { - "created": { - "descriptionHtml": "

A deployment was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "action": "dismissed", + "category": "dependabot_alert" + }, + "fixed": { + "descriptionHtml": "

A manifest file change removed a vulnerability.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11771,204 +15731,415 @@ "description": "", "isRequired": true, "enum": [ - "created" + "fixed" ], "childParamsGroups": [] }, { "type": "object", - "name": "deployment", + "name": "alert", "in": "body", - "description": "

The deployment.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", + "type": "integer", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { - "type": "object or null", - "name": "creator", - "description": "", + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "environment", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "original_environment", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or string", - "name": "payload", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "created_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true }, { "type": "string or null", - "name": "external_url", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", "description": "", "isRequired": true }, @@ -11979,551 +16150,125 @@ "isRequired": true }, { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", + "type": "string", + "name": "followers_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", + "name": "following_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "gists_url", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "owner", + "type": "string", + "name": "starred_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "updated_at", + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" } ] }, { - "type": "boolean", - "name": "production_environment", - "description": "" - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "" + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] }, { - "type": "string", - "name": "updated_at", - "description": "", + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, { "type": "object", - "name": "enterprise", + "name": "installation", "in": "body", - "description": "

An enterprise on GitHub.

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { "type": "object", - "name": "installation", + "name": "organization", "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "description": "

A GitHub organization.

", "childParamsGroups": [] }, { "type": "object", - "name": "organization", + "name": "enterprise", "in": "body", - "description": "

A GitHub organization.

", + "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, { @@ -12541,1285 +16286,1243 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - }, + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "fixed", + "category": "dependabot_alert" + }, + "reintroduced": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ { - "type": "object or null", - "name": "workflow", + "type": "string", + "name": "action", "in": "body", "description": "", "isRequired": true, + "enum": [ + "reintroduced" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, { "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "check_suite_node_id", - "description": "", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, { "type": "string", "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "event", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "head_branch", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, - { - "type": "null", - "name": "head_commit", - "description": "" - }, { "type": "object", - "name": "head_repository", - "description": "", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "archive_url", + "type": "string or null", + "name": "name", "description": "" }, { - "type": "string", - "name": "assignees_url", + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "blobs_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "branches_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "collaborators_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commits_url", - "description": "" + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "compare_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contents_url", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "forks_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "full_name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_commits_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_refs_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_tags_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_comment_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "issues_url", - "description": "" + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", + "name": "starred_at", "description": "" - }, + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reintroduced", + "category": "dependabot_alert" + }, + "reopened": { + "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "

The security alert number.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "labels_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { - "type": "string", - "name": "merges_url", - "description": "" - }, + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "milestones_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "object", - "name": "owner", - "description": "", + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" - }, + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "repos_url", - "description": "" + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" - }, + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "starred_url", - "description": "" + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" - }, + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "type", - "description": "" + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] }, { "type": "string", - "name": "url", - "description": "" + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true } ] }, { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "statuses_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "subscribers_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "subscription_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "tags_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "teams_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "trees_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] } ] }, { "type": "string", - "name": "head_sha", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "path", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "name", + "description": "" }, { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "email", + "description": "" }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "integer", - "name": "number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "node_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "path", + "name": "avatar_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", + "type": "string or null", + "name": "gravatar_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "labels_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "merges_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "milestones_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", + "name": "type", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", + "name": "starred_at", "description": "" } ] }, { - "type": "string", - "name": "rerun_url", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "dependabot_alert" + } + }, + "deploy_key": { + "created": { + "descriptionHtml": "

A deploy key was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "added_by", "description": "" }, { - "type": "integer", - "name": "run_attempt", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "run_number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "run_started_at", + "name": "key", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "object or null", - "name": "triggering_actor", + "type": "boolean", + "name": "read_only", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "title", "description": "", "isRequired": true }, @@ -13830,17 +17533,35 @@ "isRequired": true }, { - "type": "integer", - "name": "workflow_id", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" } ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] } ], "availability": [ @@ -13849,13 +17570,11 @@ "app" ], "action": "created", - "category": "deployment" - } - }, - "deployment_status": { - "created": { - "descriptionHtml": "

A new deployment status was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "category": "deploy_key" + }, + "deleted": { + "descriptionHtml": "

A deploy key was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -13864,108 +17583,134 @@ "description": "", "isRequired": true, "enum": [ - "created" + "deleted" ], "childParamsGroups": [] }, { - "type": "object or null", - "name": "check_run", + "type": "object", + "name": "enterprise", "in": "body", - "description": "", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - "skipped", - null - ] + "name": "added_by", + "description": "" }, { "type": "string", - "name": "details_url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "external_id", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", + "name": "key", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The name of the check run.

", + "type": "boolean", + "name": "read_only", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { "type": "string", - "name": "started_at", + "name": "url", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "pending" - ] - }, - { - "type": "string", - "name": "url", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "deploy_key" + } + }, + "deployment": { + "created": { + "descriptionHtml": "

A deployment was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "deployment", @@ -14130,7 +17875,7 @@ "isRequired": true }, { - "type": "null or string or object", + "type": "object or string", "name": "payload", "description": "", "isRequired": true @@ -14696,718 +18441,6 @@ } ] }, - { - "type": "object", - "name": "deployment_status", - "in": "body", - "description": "

The deployment status.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "deployment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

The optional human-readable description added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "log_url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The new state. Can be pending, success, failure, or error.

", - "isRequired": true - }, - { - "type": "string", - "name": "target_url", - "description": "

The optional link added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "object", "name": "enterprise", @@ -15450,6 +18483,7 @@ "name": "workflow", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -15518,6 +18552,7 @@ "name": "workflow_run", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "object or null", @@ -15679,8 +18714,7 @@ "timed_out", "action_required", "stale", - null, - "startup_failure" + null ] }, { @@ -16604,7 +19638,6 @@ "type": "object or null", "name": "triggering_actor", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -16752,13 +19785,13 @@ "app" ], "action": "created", - "category": "deployment_status" + "category": "deployment" } }, - "discussion": { - "answered": { - "descriptionHtml": "

A comment on the discussion was marked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "deployment_status": { + "created": { + "descriptionHtml": "

A new deployment status was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -16767,55 +19800,55 @@ "description": "", "isRequired": true, "enum": [ - "answered" + "created" ], "childParamsGroups": [] }, { - "type": "object", - "name": "answer", + "type": "object or null", + "name": "check_run", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", "isRequired": true, "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + "skipped", + null ] }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", + "name": "details_url", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "external_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", - "description": "", + "type": "string", + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { @@ -16827,7 +19860,13 @@ { "type": "integer", "name": "id", - "description": "", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check run.

", "isRequired": true }, { @@ -16837,93 +19876,48 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "string", + "name": "started_at", "description": "", "isRequired": true }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } + "type": "string", + "name": "status", + "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "pending" ] }, { "type": "string", - "name": "repository_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "

The deployment.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "updated_at", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "user", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17040,113 +20034,145 @@ "description": "" } ] - } - ] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "answered", - "category": "discussion" - }, - "category_changed": { - "descriptionHtml": "

The category of a discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "category_changed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "category", + "type": "string or null", + "name": "description", "description": "", - "isRequired": true, + "isRequired": true + }, + { + "type": "string", + "name": "environment", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "", + "isRequired": true + }, + { + "type": "null or string or object", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "object", - "name": "from", + "type": "string or null", + "name": "created_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" }, { "type": "integer", @@ -17155,16 +20181,15 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", @@ -17172,51 +20197,457 @@ "description": "" }, { - "type": "integer", - "name": "repository_id", + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "slug", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] }, { "type": "string", - "name": "updated_at", + "name": "administration", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "production_environment", + "description": "" + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "discussion", + "name": "deployment_status", "in": "body", - "description": "", + "description": "

The deployment status.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "answer_chosen_by", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17334,118 +20765,28 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, { "type": "string", - "name": "body", + "name": "deployment_url", "description": "", "isRequired": true }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", + "type": "string", + "name": "description", + "description": "

The optional human-readable description added to the status.

", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "environment", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "environment_url", + "description": "" }, { "type": "integer", @@ -17454,10 +20795,9 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "string", + "name": "log_url", + "description": "" }, { "type": "string", @@ -17466,302 +20806,543 @@ "isRequired": true }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", "name": "name", - "description": "" + "description": "

The name of the GitHub app

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "object or null", + "name": "owner", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } ] }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "category_changed", - "category": "discussion" - }, - "created": { - "descriptionHtml": "

A discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The new state. Can be pending, success, failure, or error.

", + "isRequired": true + }, + { + "type": "string", + "name": "target_url", + "description": "

The optional link added to the status.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "object", @@ -17799,53 +21380,84 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "discussion" - }, - "deleted": { - "descriptionHtml": "

A discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] }, { - "type": "object", - "name": "discussion", + "type": "object or null", + "name": "workflow", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "badge_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "workflow_run", + "in": "body", + "description": "", + "childParamsGroups": [ { "type": "object or null", - "name": "answer_chosen_by", + "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17963,525 +21575,187 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "artifacts_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "name": "cancel_url", + "description": "" }, { "type": "integer", - "name": "comments", + "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "check_suite_url", + "description": "" }, { - "type": "boolean", - "name": "locked", + "type": "string or null", + "name": "conclusion", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" + ] }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "string", - "name": "repository_url", + "name": "display_title", "description": "", "isRequired": true }, { "type": "string", - "name": "state", + "name": "event", "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" + "isRequired": true }, { "type": "string", - "name": "title", + "name": "head_branch", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "null", + "name": "head_commit", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "object", + "name": "head_repository", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", + "name": "archive_url", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "assignees_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "blobs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "branches_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "collaborators_url", "description": "" }, { "type": "string", - "name": "html_url", + "name": "comments_url", "description": "" }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "name", + "name": "commits_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "compare_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "contents_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "contributors_url", "description": "" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "deployments_url", "description": "" }, { - "type": "string", - "name": "starred_url", + "type": "null", + "name": "description", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "downloads_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "discussion" - }, - "edited": { - "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", + "name": "events_url", "description": "" }, { "type": "boolean", - "name": "deleted", + "name": "fork", "description": "" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "forks_url", "description": "" }, { "type": "string", - "name": "events_url", + "name": "full_name", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "git_commits_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "git_refs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "git_tags_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "hooks_url", "description": "" }, { @@ -18492,124 +21766,366 @@ { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "name", + "name": "issue_comment_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "issue_events_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "issues_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "keys_url", "description": "" }, { "type": "string", - "name": "repos_url", + "name": "labels_url", "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "languages_url", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "merges_url", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "milestones_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "name", + "description": "" }, { "type": "string", - "name": "url", + "name": "node_id", "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "notifications_url", + "description": "" }, { - "type": "string", - "name": "emoji", + "type": "object", + "name": "owner", "description": "", - "isRequired": true - }, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "jobs_url", + "description": "" + }, + { + "type": "string", + "name": "logs_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "previous_attempt_url", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, { "type": "integer", "name": "id", @@ -18617,69 +22133,636 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects or null", + "name": "referenced_workflows", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "" + }, + { + "type": "string", + "name": "sha", "description": "", "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" }, { "type": "string", "name": "node_id", "description": "" }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "rerun_url", + "description": "" + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + { + "type": "object or null", + "name": "triggering_actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, { "type": "integer", - "name": "repository_id", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "slug", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "integer", - "name": "comments", + "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "workflow_url", + "description": "" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "deployment_status" + } + }, + "discussion": { + "answered": { + "descriptionHtml": "

A comment on the discussion was marked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "answered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "answer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "discussion_id", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, @@ -18690,8 +22773,8 @@ "isRequired": true }, { - "type": "integer", - "name": "number", + "type": "null", + "name": "parent_id", "description": "", "isRequired": true }, @@ -18768,29 +22851,6 @@ "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, { "type": "string", "name": "updated_at", @@ -18919,6 +22979,13 @@ } ] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "enterprise", @@ -18962,11 +23029,11 @@ "organization", "app" ], - "action": "edited", + "action": "answered", "category": "discussion" }, - "labeled": { - "descriptionHtml": "

A label was added to a discussion.

", + "category_changed": { + "descriptionHtml": "

The category of a discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -18976,10 +23043,94 @@ "description": "", "isRequired": true, "enum": [ - "labeled" + "category_changed" ], "childParamsGroups": [] }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, { "type": "object", "name": "discussion", @@ -19142,7 +23293,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -19496,58 +23647,7 @@ }, { "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", + "name": "organization", "in": "body", "description": "

A GitHub organization.

", "childParamsGroups": [] @@ -19574,11 +23674,11 @@ "organization", "app" ], - "action": "labeled", + "action": "category_changed", "category": "discussion" }, - "locked": { - "descriptionHtml": "

A discussion was locked.

", + "created": { + "descriptionHtml": "

A discussion was created.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19588,7 +23688,7 @@ "description": "", "isRequired": true, "enum": [ - "locked" + "created" ], "childParamsGroups": [] }, @@ -19642,11 +23742,11 @@ "organization", "app" ], - "action": "locked", + "action": "created", "category": "discussion" }, - "pinned": { - "descriptionHtml": "

A discussion was pinned.

", + "deleted": { + "descriptionHtml": "

A discussion was deleted.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19656,7 +23756,7 @@ "description": "", "isRequired": true, "enum": [ - "pinned" + "deleted" ], "childParamsGroups": [] }, @@ -20203,11 +24303,11 @@ "organization", "app" ], - "action": "pinned", + "action": "deleted", "category": "discussion" }, - "transferred": { - "descriptionHtml": "

A discussion was transferred to another repository.

", + "edited": { + "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -20217,7 +24317,7 @@ "description": "", "isRequired": true, "enum": [ - "transferred" + "edited" ], "childParamsGroups": [] }, @@ -20226,258 +24326,104 @@ "name": "changes", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "new_discussion", + "name": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "from", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "title", + "description": "", + "childParamsGroups": [ { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "from", "description": "", "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "name": "email", + "description": "" }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", @@ -20486,979 +24432,490 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "node_id", + "description": "" }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "name": "repos_url", + "description": "" }, { - "type": "string", - "name": "timeline_url", + "type": "boolean", + "name": "site_admin", "description": "" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "string", + "name": "type", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "new_repository", - "description": "

A git repository

", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, { "type": "string", - "name": "archive_url", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, { "type": "string", - "name": "assignees_url", + "name": "description", "description": "", "isRequired": true }, { "type": "string", - "name": "blobs_url", + "name": "emoji", "description": "", "isRequired": true }, { - "type": "string", - "name": "branches_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "clone_url", + "type": "boolean", + "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", - "name": "collaborators_url", + "name": "name", "description": "", "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { - "type": "string", - "name": "commits_url", + "type": "integer", + "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", - "name": "compare_url", + "name": "slug", "description": "", "isRequired": true }, { "type": "string", - "name": "contents_url", + "name": "updated_at", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ { - "type": "string", - "name": "contributors_url", + "type": "integer", + "name": "+1", "description": "", "isRequired": true }, { - "type": "integer or string", - "name": "created_at", + "type": "integer", + "name": "-1", "description": "", "isRequired": true }, { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "fork", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks", + "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks_count", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "forks_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "deleted", + "description": "" }, { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true + "name": "followers_url", + "description": "" }, { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", - "name": "issue_events_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true + "type": "string", + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "master_branch", + "name": "starred_url", "description": "" }, { "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { "type": "string", - "name": "milestones_url", + "name": "type", "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "discussion" + }, + "labeled": { + "descriptionHtml": "

A label was added to a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "labeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -21621,7 +25078,7 @@ ] }, { - "type": "string", + "type": "string or null", "name": "body", "description": "", "isRequired": true @@ -21973,6 +25430,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -22002,11 +25510,11 @@ "organization", "app" ], - "action": "transferred", + "action": "labeled", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "locked": { + "descriptionHtml": "

A discussion was locked.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22016,7 +25524,7 @@ "description": "", "isRequired": true, "enum": [ - "unanswered" + "locked" ], "childParamsGroups": [] }, @@ -22041,278 +25549,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "old_answer", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, { "type": "object", "name": "organization", @@ -22333,6 +25569,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -22341,11 +25578,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "locked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "

A label was removed from a discussion.

", + "pinned": { + "descriptionHtml": "

A discussion was pinned.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22355,7 +25592,7 @@ "description": "", "isRequired": true, "enum": [ - "unlabeled" + "pinned" ], "childParamsGroups": [] }, @@ -22873,125 +26110,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlabeled", - "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "

A discussion was unlocked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "unlocked" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, { "type": "object", "name": "organization", @@ -23021,11 +26139,11 @@ "organization", "app" ], - "action": "unlocked", + "action": "pinned", "category": "discussion" }, - "unpinned": { - "descriptionHtml": "

A discussion was unpinned.

", + "transferred": { + "descriptionHtml": "

A discussion was transferred to another repository.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -23035,852 +26153,1254 @@ "description": "", "isRequired": true, "enum": [ - "unpinned" + "transferred" ], "childParamsGroups": [] }, { "type": "object", - "name": "discussion", + "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", + "type": "object", + "name": "new_discussion", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "active_lock_reason", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "string or null", + "name": "answer_chosen_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", + "type": "object or null", + "name": "answer_chosen_by", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "created_at", + "type": "string or null", + "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "emoji", + "name": "body", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "slug", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", - "name": "confused", + "name": "number", "description": "", "isRequired": true }, { - "type": "integer", - "name": "eyes", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "state", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "timeline_url", + "description": "" }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "title", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "object or null", + "name": "user", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", + "type": "object", + "name": "new_repository", + "description": "

A git repository

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "allow_forking", + "description": "

Whether to allow private forks

" }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true }, { - "type": "string", - "name": "followers_url", + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", "description": "" }, { "type": "string", - "name": "following_url", - "description": "" + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "assignees_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "blobs_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" + "name": "branches_url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "comments_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "commits_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "compare_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "contents_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "contributors_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false }, { "type": "string", - "name": "type", + "name": "deployments_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unpinned", - "category": "discussion" - } - }, - "discussion_comment": { - "created": { - "descriptionHtml": "

A comment on a discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "events_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", + "type": "boolean", + "name": "fork", "description": "", "isRequired": true }, { "type": "integer", - "name": "eyes", + "name": "forks", "description": "", "isRequired": true }, { "type": "integer", - "name": "heart", + "name": "forks_count", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "forks_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "laugh", + "type": "string", + "name": "full_name", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "git_commits_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "git_tags_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "avatar_url", - "description": "" + "name": "git_url", + "description": "", + "isRequired": true }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "following_url", - "description": "" + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "boolean", + "name": "is_template", "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "issue_comment_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "issue_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "issues_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "labels_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true }, { "type": "string", - "name": "type", + "name": "languages_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", @@ -24037,7 +27557,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -24418,12 +27938,12 @@ "organization", "app" ], - "action": "created", - "category": "discussion_comment" + "action": "transferred", + "category": "discussion" }, - "deleted": { - "descriptionHtml": "

A comment on a discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unanswered": { + "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -24432,13 +27952,34 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "unanswered" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "comment", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "old_answer", "in": "body", "description": "", "isRequired": true, @@ -24502,7 +28043,7 @@ "isRequired": true }, { - "type": "integer or null", + "type": "null", "name": "parent_id", "description": "", "isRequired": true @@ -24511,7 +28052,6 @@ "type": "object", "name": "reactions", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "integer", @@ -24709,6 +28249,52 @@ } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unanswered", + "category": "discussion" + }, + "unlabeled": { + "descriptionHtml": "

A label was removed from a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -25223,6 +28809,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -25252,12 +28889,12 @@ "organization", "app" ], - "action": "deleted", - "category": "discussion_comment" + "action": "unlabeled", + "category": "discussion" }, - "edited": { - "descriptionHtml": "

A comment on a discussion was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unlocked": { + "descriptionHtml": "

A discussion was unlocked.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -25266,33 +28903,641 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "unlocked" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", - "name": "changes", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlocked", + "category": "discussion" + }, + "unpinned": { + "descriptionHtml": "

A discussion was unpinned.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unpinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", "name": "body", "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "from", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unpinned", + "category": "discussion" + } + }, + "discussion_comment": { + "created": { + "descriptionHtml": "

A comment on a discussion was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "comment", @@ -26109,74 +30354,12 @@ "organization", "app" ], - "action": "edited", + "action": "created", "category": "discussion_comment" - } - }, - "fork": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "forkee", - "in": "body", - "description": "

The created repository resource.

", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "default", - "category": "fork" - } - }, - "github_app_authorization": { - "revoked": { - "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + }, + "deleted": { + "descriptionHtml": "

A comment on a discussion was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26185,215 +30368,67 @@ "description": "", "isRequired": true, "enum": [ - "revoked" + "deleted" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "revoked", - "category": "github_app_authorization" - } - }, - "gollum": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "pages", + "name": "comment", "in": "body", - "description": "

The pages that were updated.

", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "action", - "description": "

The action that was performed on the page. Can be created or edited.

", + "name": "author_association", + "description": "

How the author is associated with the repository.

", "isRequired": true, "enum": [ - "created", - "edited" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, { "type": "string", - "name": "html_url", - "description": "

Points to the HTML wiki page.

", + "name": "body", + "description": "", "isRequired": true }, { - "type": "string", - "name": "page_name", - "description": "

The name of the page.

", + "type": "integer", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "sha", - "description": "

The latest commit SHA of the page.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "summary", + "type": "integer", + "name": "discussion_id", "description": "", "isRequired": true }, { "type": "string", - "name": "title", - "description": "

The current page title.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "gollum" - } - }, - "installation": { - "created": { - "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "description": "", "isRequired": true }, { @@ -26403,214 +30438,475 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requester", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "type": "integer or null", + "name": "parent_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "repository_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "type", + "name": "body", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } ] }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "created", - "category": "installation" - }, - "deleted": { - "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + "name": "created_at", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", + "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "type": "boolean", + "name": "locked", + "description": "", "isRequired": true }, { @@ -26620,159 +30916,235 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "deleted", - "category": "installation" - }, - "new_permissions_accepted": { - "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "new_permissions_accepted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", - "name": "full_name", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true + "name": "timeline_url", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "new_permissions_accepted", - "category": "installation" - }, - "suspend": { - "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "suspend" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "enterprise", @@ -26784,8 +31156,7 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", - "isRequired": true, + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { @@ -26795,57 +31166,14 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, { "type": "object", "name": "repository", "in": "body", "description": "

A repository on GitHub.

", + "isRequired": true, "childParamsGroups": [] }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, { "type": "object", "name": "sender", @@ -26856,14 +31184,16 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "suspend", - "category": "installation" + "action": "deleted", + "category": "discussion_comment" }, - "unsuspend": { - "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "edited": { + "descriptionHtml": "

A comment on a discussion was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26872,54 +31202,90 @@ "description": "", "isRequired": true, "enum": [ - "unsuspend" + "edited" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", + "name": "changes", "in": "body", - "description": "

Installation

", + "description": "", "isRequired": true, - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] }, { "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", + "name": "comment", "in": "body", - "description": "

An array of repository objects that the installation can access.

", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { @@ -26929,26 +31295,742 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer or null", + "name": "parent_id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, { "type": "object", "name": "sender", @@ -26959,16 +32041,78 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "unsuspend", - "category": "installation" + "action": "edited", + "category": "discussion_comment" } }, - "installation_repositories": { - "added": { - "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "fork": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "forkee", + "in": "body", + "description": "

The created repository resource.

", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "default", + "category": "fork" + } + }, + "github_app_authorization": { + "revoked": { + "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", "bodyParameters": [ { "type": "string", @@ -26977,7 +32121,7 @@ "description": "", "isRequired": true, "enum": [ - "added" + "revoked" ], "childParamsGroups": [] }, @@ -26992,9 +32136,57 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "revoked", + "category": "github_app_authorization" + } + }, + "gollum": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] }, { "type": "object", @@ -27005,74 +32197,152 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "pages", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", + "description": "

The pages that were updated.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "action", + "description": "

The action that was performed on the page. Can be created or edited.

", + "isRequired": true, + "enum": [ + "created", + "edited" + ] }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "type": "string", + "name": "html_url", + "description": "

Points to the HTML wiki page.

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "page_name", + "description": "

The name of the page.

", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "sha", + "description": "

The latest commit SHA of the page.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "title", + "description": "

The current page title.

", "isRequired": true } ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "gollum" + } + }, + "installation": { + "created": { + "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", "name": "full_name", - "description": "" + "description": "", + "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

" + "description": "

Unique identifier of the repository

", + "isRequired": true }, { "type": "string", "name": "name", - "description": "

The name of the repository.

" + "description": "

The name of the repository.

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "", + "isRequired": true }, { "type": "boolean", "name": "private", - "description": "

Whether the repository is private or public.

" + "description": "

Whether the repository is private or public.

", + "isRequired": true } ] }, @@ -27083,23 +32353,11 @@ "description": "

A repository on GitHub.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "repository_selection", - "in": "body", - "description": "

Describe whether all repositories have been selected or there's a selection involved

", - "isRequired": true, - "enum": [ - "all", - "selected" - ] - }, { "type": "object or null", "name": "requester", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -27227,12 +32485,12 @@ "availability": [ "app" ], - "action": "added", - "category": "installation_repositories" + "action": "created", + "category": "installation" }, - "removed": { - "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "deleted": { + "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -27241,7 +32499,7 @@ "description": "", "isRequired": true, "enum": [ - "removed" + "deleted" ], "childParamsGroups": [] }, @@ -27269,10 +32527,9 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "repositories", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", - "isRequired": true, + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", @@ -27307,20 +32564,699 @@ ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "deleted", + "category": "installation" + }, + "new_permissions_accepted": { + "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "new_permissions_accepted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "new_permissions_accepted", + "category": "installation" + }, + "suspend": { + "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "suspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "suspend", + "category": "installation" + }, + "unsuspend": { + "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unsuspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "unsuspend", + "category": "installation" + } + }, + "installation_repositories": { + "added": { + "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

" + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "

Describe whether all repositories have been selected or there's a selection involved

", + "isRequired": true, + "enum": [ + "all", + "selected" + ] + }, + { + "type": "object or null", + "name": "requester", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "added", + "category": "installation_repositories" + }, + "removed": { + "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", "name": "id", "description": "

Unique identifier of the repository

", "isRequired": true @@ -59770,166 +65706,3523 @@ }, { "type": "string", - "name": "organizations_url", - "description": "", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "deleted", + "category": "projects_v2_item" + }, + "edited": { + "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object or object", + "name": "changes", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2_item" + }, + "reordered": { + "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reordered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "previous_projects_v2_item_node_id", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "reordered", + "category": "projects_v2_item" + }, + "restored": { + "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "restored" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "archived_at", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "restored", + "category": "projects_v2_item" + } + }, + "public": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "public" + } + }, + "pull_request": { + "assigned": { + "descriptionHtml": "

A pull request was assigned to a user.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "

The status of auto merging a pull request.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "

Commit message for the merge commit.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "

Title for the merge commit message.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "

The merge method to use.

", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "

Indicates whether or not the pull request is a draft.

", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", "isRequired": true }, { - "type": "string", - "name": "repos_url", + "type": "boolean", + "name": "default", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "received_events_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "name", + "description": "

The name of the label.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_at", - "description": "" + "name": "url", + "description": "

URL for the label

", + "isRequired": true } ] }, { - "type": "string", - "name": "created_at", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "boolean", + "name": "maintainer_can_modify", + "description": "

Indicates whether maintainers can modify the pull request.

" }, { "type": "string or null", - "name": "archived_at", + "name": "merge_commit_sha", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "deleted", - "category": "projects_v2_item" - }, - "edited": { - "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object or object", - "name": "changes", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "number", - "name": "id", - "description": "", - "isRequired": true + "type": "boolean or null", + "name": "mergeable", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "mergeable_state", "description": "" }, { - "type": "string", - "name": "project_node_id", + "type": "boolean or null", + "name": "merged", "description": "" }, { - "type": "string", - "name": "content_node_id", + "type": "string or null", + "name": "merged_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "object or null", + "name": "merged_by", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -59939,298 +69232,257 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2_item" - }, - "reordered": { - "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reordered" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "previous_projects_v2_item_node_id", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", + "name": "url", "description": "" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "project_node_id", - "description": "" - }, - { - "type": "string", - "name": "content_node_id", - "description": "", - "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", "childParamsGroups": [ { "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", + "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "object or null", + "name": "creator", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "string or null", - "name": "gravatar_id", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "due_on", "description": "", "isRequired": true }, @@ -60241,217 +69493,312 @@ "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", + "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_url", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "", + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", "isRequired": true }, { - "type": "string", - "name": "organizations_url", + "type": "integer", + "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] }, { "type": "string", - "name": "events_url", - "description": "", + "name": "title", + "description": "

The title of the milestone.

", "isRequired": true }, { "type": "string", - "name": "received_events_url", + "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", + "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, { "type": "string", - "name": "created_at", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "integer", + "name": "number", + "description": "

Number uniquely identifying the pull request within its repository.

", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "patch_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "archived_at", + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reordered", - "category": "projects_v2_item" - }, - "restored": { - "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "restored" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "archived_at", + "type": "array of objects", + "name": "requested_teams", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "from", + "type": "boolean", + "name": "deleted", "description": "" }, { "type": "string or null", - "name": "to", + "name": "description", + "description": "

Description of the team

" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "

Description of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", "description": "" + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "review_comment_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "project_node_id", + "type": "integer", + "name": "review_comments", "description": "" }, { "type": "string", - "name": "content_node_id", + "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "name": "state", + "description": "

State of this Pull Request. Either open or closed.

", "isRequired": true, "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "open", + "closed" ] }, { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "

The title of the pull request.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -60461,181 +69808,106 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true } ] }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "restored", - "category": "projects_v2_item" - } - }, - "public": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, { "type": "object", "name": "repository", @@ -60658,13 +69930,11 @@ "organization", "app" ], - "action": "default", - "category": "public" - } - }, - "pull_request": { - "assigned": { - "descriptionHtml": "

A pull request was assigned to a user.

", + "action": "assigned", + "category": "pull_request" + }, + "auto_merge_disabled": { + "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -60674,131 +69944,10 @@ "description": "", "isRequired": true, "enum": [ - "assigned" + "auto_merge_disabled" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "assignee", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, { "type": "object", "name": "enterprise", @@ -60817,7 +69966,7 @@ "type": "integer", "name": "number", "in": "body", - "description": "

The pull request number.

", + "description": "", "isRequired": true }, { @@ -61082,8 +70231,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -61512,6 +70660,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "boolean", "name": "has_pages", @@ -61532,13 +70687,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "string or null", "name": "homepage", @@ -62255,7 +71403,7 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", + "type": "string", "name": "label", "description": "", "isRequired": true @@ -62267,7 +71415,7 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "repo", "description": "

A git repository

", "isRequired": true, @@ -63527,8 +72675,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -63972,6 +73119,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -63994,11 +73148,11 @@ "organization", "app" ], - "action": "assigned", + "action": "auto_merge_disabled", "category": "pull_request" }, - "auto_merge_disabled": { - "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "auto_merge_enabled": { + "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -64008,7 +73162,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_disabled" + "auto_merge_enabled" ], "childParamsGroups": [] }, @@ -64724,13 +73878,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "boolean", "name": "has_pages", @@ -64751,6 +73898,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "string or null", "name": "homepage", @@ -66739,7 +75893,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -67187,6 +76342,80 @@ "type": "string", "name": "reason", "in": "body", + "description": "" + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "auto_merge_enabled", + "category": "pull_request" + }, + "closed": { + "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, @@ -67212,11 +76441,11 @@ "organization", "app" ], - "action": "auto_merge_disabled", + "action": "closed", "category": "pull_request" }, - "auto_merge_enabled": { - "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "converted_to_draft": { + "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -67226,7 +76455,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_enabled" + "converted_to_draft" ], "childParamsGroups": [] }, @@ -67248,9 +76477,311 @@ "type": "integer", "name": "number", "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "converted_to_draft", + "category": "pull_request" + }, + "demilestoned": { + "descriptionHtml": "

A pull request was removed from a milestone.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "demilestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "

A collection of related issues and pull requests.

", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -67513,7 +77044,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -68455,7 +77987,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69437,7 +78969,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69813,7 +79345,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -70399,725 +79932,340 @@ "description": "" } ] - } - ] - }, - { - "type": "string", - "name": "reason", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_merge_enabled", - "category": "pull_request" - }, - "closed": { - "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "pull_request" - }, - "converted_to_draft": { - "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "converted_to_draft" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "converted_to_draft", - "category": "pull_request" - }, - "demilestoned": { - "descriptionHtml": "

A pull request was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "demilestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "in": "body", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "demilestoned", + "category": "pull_request" + }, + "dequeued": { + "descriptionHtml": "

A pull request was removed from the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "dequeued" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "array of object,nulls", @@ -72051,7 +81199,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73033,7 +82181,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73409,8 +82557,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -73999,6 +83146,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -74012,6 +83166,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -74020,7 +83175,7 @@ "organization", "app" ], - "action": "demilestoned", + "action": "dequeued", "category": "pull_request" }, "edited": { @@ -140222,9 +149377,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -140632,9 +149787,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141459,9 +150614,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141870,9 +151025,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", diff --git a/lib/webhooks/static/decorated/github.ae.json b/lib/webhooks/static/decorated/github.ae.json index d78ccc54c29c..460b860eb51e 100644 --- a/lib/webhooks/static/decorated/github.ae.json +++ b/lib/webhooks/static/decorated/github.ae.json @@ -5002,12 +5002,10 @@ ], "action": "created", "category": "check_run" - } - }, - "check_suite": { - "completed": { - "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", + }, + "requested_action": { + "descriptionHtml": "

A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -5016,29 +5014,17 @@ "description": "", "isRequired": true, "enum": [ - "completed" + "requested_action" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "actions_meta", - "in": "body", - "description": "" - }, { "type": "object", - "name": "check_suite", + "name": "check_run", "in": "body", - "description": "

The check_suite.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "", - "isRequired": true - }, { "type": "object", "name": "app", @@ -5046,45 +5032,15 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", + "type": "integer", "name": "id", "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", @@ -5093,19 +5049,14 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "owner", - "description": "", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "type": "string or null", + "name": "name", "description": "" }, { @@ -5115,590 +5066,1765 @@ }, { "type": "string", - "name": "events_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", + "type": "string or null", "name": "gravatar_id", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "followers_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "following_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "organizations_url", - "description": "" + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "received_events_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { "type": "boolean", "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "checks", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "metadata", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "contents", + "description": "" }, { "type": "string", - "name": "url", + "name": "deployments", "description": "" } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, { "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "administration", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, { "type": "string", - "name": "checks", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "content_references", + "name": "external_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "contents", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "deployments", + "name": "created_at", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "discussions", + "name": "updated_at", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } ] }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] + "name": "client_id", + "description": "" }, { "type": "string", - "name": "environments", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues", + "name": "url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] }, { - "type": "string", - "name": "keys", + "type": "object", + "name": "base", "description": "", - "enum": [ - "read", - "write" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "

Minimal Repository

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "members", + "name": "node_id", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "metadata", + "name": "name", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_administration", + "name": "full_name", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } ] }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "organization_hooks", + "name": "html_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organization_packages", + "name": "url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_plan", + "name": "archive_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_projects", + "name": "assignees_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "organization_secrets", + "name": "blobs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_self_hosted_runners", + "name": "branches_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "organization_user_blocking", + "name": "collaborators_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "packages", + "name": "comments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pages", + "name": "commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "pull_requests", + "name": "compare_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_hooks", + "name": "contents_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "repository_projects", + "name": "contributors_url", "description": "", - "enum": [ - "read", - "write", - "admin" - ] + "isRequired": true }, { "type": "string", - "name": "secret_scanning_alerts", + "name": "deployments_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "secrets", + "name": "downloads_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_events", + "name": "events_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "security_scanning_alert", + "name": "forks_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "single_file", + "name": "git_commits_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "statuses", + "name": "git_refs_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "team_discussions", + "name": "git_tags_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "vulnerability_alerts", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", "description": "", - "enum": [ - "read", - "write" - ] + "isRequired": true }, { "type": "string", - "name": "workflows", + "name": "issue_events_url", "description": "", - "enum": [ - "read", - "write" + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" } ] }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] }, { - "type": "string or null", + "type": "string", "name": "updated_at", - "description": "", - "isRequired": true + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { "type": "string or null", - "name": "before", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "check_runs_url", + "name": "completed_at", "description": "", "isRequired": true }, { "type": "string or null", "name": "conclusion", - "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "description": "", "isRequired": true, "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", "success", "failure", "neutral", "cancelled", + "skipped", "timed_out", "action_required", - "stale", - null, - "skipped", - "startup_failure" + null ] }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "head_branch", - "description": "

The head branch name the changes are on.

", - "isRequired": true - }, { "type": "object", - "name": "head_commit", - "description": "", - "isRequired": true, + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "

Parameter to specify a task to execute

", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" + }, { "type": "object", - "name": "author", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, { "type": "string", "name": "name", - "description": "

The git author's name.

", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "string", - "name": "username", - "description": "" - } - ] - }, - { - "type": "object", - "name": "committer", - "description": "

Metaproperties for Git author/committer information.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "date", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The git author's name.

", + "name": "updated_at", + "description": "", "isRequired": true }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, { "type": "string", - "name": "username", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "message", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "timestamp", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tree_id", - "description": "", - "isRequired": true } ] }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, { "type": "string", "name": "head_sha", - "description": "

The SHA of the head commit that is being checked.

", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", - "name": "latest_check_runs_count", - "description": "", + "name": "id", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { @@ -5707,15 +6833,71 @@ "description": "", "isRequired": true }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, { "type": "array of objects", "name": "pull_requests", - "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "description": "", "isRequired": true, "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "base", + "name": "head", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5725,6 +6907,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5739,29 +6927,23 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] }, { "type": "object", - "name": "head", + "name": "base", "description": "", "isRequired": true, "childParamsGroups": [ @@ -5771,6 +6953,12 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repo", @@ -5785,91 +6973,48 @@ }, { "type": "string", - "name": "name", + "name": "url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "name", "description": "", "isRequired": true } ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true } ] - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true } ] }, { - "type": "boolean", - "name": "rerequestable", - "description": "" - }, - { - "type": "boolean", - "name": "runs_rerequestable", - "description": "" + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true }, { - "type": "string or null", + "type": "string", "name": "status", - "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "requested", + "queued", "in_progress", "completed", - "queued", - null, "pending" ] }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "

URL that points to the check suite API resource.

", + "description": "", "isRequired": true } ] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -5892,6 +7037,19 @@ "isRequired": true, "childParamsGroups": [] }, + { + "type": "object", + "name": "requested_action", + "in": "body", + "description": "

The action requested by the user.

", + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The integrator reference of the action requested by the user.

" + } + ] + }, { "type": "object", "name": "sender", @@ -5906,516 +7064,592 @@ "organization", "app" ], - "action": "completed", - "category": "check_suite" - } - }, - "code_scanning_alert": { - "appeared_in_branch": { - "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "requested_action", + "category": "check_run" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", "description": "", - "isRequired": true, "enum": [ - "appeared_in_branch" + "rerequested" ], "childParamsGroups": [] }, { "type": "object", - "name": "alert", + "name": "check_run", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "

A check performed on the code of a given code change

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string", - "name": "events_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { "type": "string", - "name": "following_url", - "description": "" + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] }, { - "type": "string", - "name": "organizations_url", - "description": "" + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "client_id", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "client_secret", "description": "" }, { - "type": "string", - "name": "subscriptions_url", + "type": "string or null", + "name": "webhook_secret", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", + "name": "pem", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "object", + "name": "check_suite", + "description": "

A suite of checks performed on the code of a given code change

", "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array of object,nulls", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", + "type": "string or null", + "name": "after", "description": "" }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" }, { "type": "string", - "name": "path", + "name": "client_id", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "client_secret", "description": "" }, { - "type": "integer", - "name": "start_line", + "type": "string or null", + "name": "webhook_secret", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "pem", "description": "" } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true + "type": "string or null", + "name": "before", + "description": "" }, { "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, + "name": "conclusion", + "description": "", "enum": [ - "none", - "note", - "warning", - "error", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", null ] - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "appeared_in_branch", - "category": "code_scanning_alert" - }, - "closed_by_user": { - "descriptionHtml": "

Someone closed a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", + "name": "created_at", "description": "" }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", + "name": "head_branch", "description": "" }, { "type": "string", - "name": "html_url", - "description": "" + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

" }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", "description": "" }, { @@ -6424,1034 +7658,1416 @@ "description": "" }, { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, - { - "type": "object", - "name": "location", + "type": "array of objects", + "name": "pull_requests", "description": "", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" + "name": "id", + "description": "", + "isRequired": true }, { "type": "integer", - "name": "end_line", - "description": "" + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] } ] }, { "type": "object", - "name": "message", - "description": "", + "name": "repository", + "description": "

Minimal Repository

", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "

Code Of Conduct

", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, + "name": "status", + "description": "", "enum": [ - "open", - "dismissed", - "fixed" + "queued", + "in_progress", + "completed", + "pending", + "waiting" ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "completed_at", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string or null", + "name": "conclusion", "description": "", "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "

A deployment created as the result of an Actions check run from a workflow that references an environment

", "childParamsGroups": [ { "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true }, { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the deployment

", + "isRequired": true }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "task", + "description": "

Parameter to specify a task to execute

", "isRequired": true }, { "type": "string", - "name": "name", + "name": "original_environment", "description": "" }, { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] + "type": "string", + "name": "environment", + "description": "

Name for the target deployment environment.

", + "isRequired": true }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ { "type": "string or null", - "name": "guid", - "description": "" + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed_by_user", - "category": "code_scanning_alert" - }, - "created": { - "descriptionHtml": "

A code scanning alert was created in a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_by", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

The dismissal comment associated with the dismissal of the alert.

" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "null", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "name": "statuses_url", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "boolean", + "name": "transient_environment", + "description": "

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

" }, { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true + "type": "boolean", + "name": "production_environment", + "description": "

Specifies if the given environment is one that end-users directly interact with. Default: false.

" }, { "type": "object", - "name": "location", - "description": "", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "" + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { "type": "string", - "name": "text", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "

The number of installations associated with the GitHub app

" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", "description": "" } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string", + "name": "details_url", + "description": "", "isRequired": true }, { - "type": "object", - "name": "rule", + "type": "string", + "name": "external_id", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed" - ] + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", + "isRequired": true }, { - "type": "object or null", - "name": "tool", + "type": "string", + "name": "html_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "updated_at", - "description": "" + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "integer", + "name": "id", + "description": "

The id of the check.

", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "code_scanning_alert" - }, - "fixed": { - "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "fixed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "name", + "description": "

The name of the check.

", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "dismissed_by", + "type": "object", + "name": "output", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", - "name": "id", + "name": "annotations_count", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "annotations_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "string or null", + "name": "text", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "string", - "name": "instances_url", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", + "type": "array of objects", + "name": "pull_requests", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" + "type": "integer", + "name": "number", + "description": "", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "url", + "description": "", "isRequired": true }, { "type": "object", - "name": "location", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] }, { "type": "object", - "name": "message", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] } ] - }, - { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", + "type": "string", + "name": "started_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" - }, - { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" - }, - { - "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "name": "status", + "description": "

The phase of the lifecycle that the check is currently in.

", "isRequired": true, "enum": [ - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } + "queued", + "in_progress", + "completed", + "pending" ] }, { @@ -7462,20 +9078,6 @@ } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, { "type": "object", "name": "installation", @@ -7490,13 +9092,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -7519,12 +9114,14 @@ "organization", "app" ], - "action": "fixed", - "category": "code_scanning_alert" - }, - "reopened": { - "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "action": "rerequested", + "category": "check_run" + } + }, + "check_suite": { + "completed": { + "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", @@ -7533,541 +9130,853 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "completed" ], "childParamsGroups": [] }, { "type": "object or null", - "name": "alert", + "name": "actions_meta", "in": "body", - "description": "

The code scanning alert involved in the event.

", + "description": "" + }, + { + "type": "object", + "name": "check_suite", + "in": "body", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "dismissed_by", + "name": "after", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", - "isRequired": true - }, - { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "object", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", "isRequired": true }, { "type": "array of strings", - "name": "classifications", - "description": "" + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "commit_sha", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true }, { "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "object", - "name": "location", + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "end_column", + "type": "string", + "name": "avatar_url", "description": "" }, { - "type": "integer", - "name": "end_line", + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "path", + "name": "events_url", "description": "" }, { - "type": "integer", - "name": "start_column", + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", "description": "" }, { "type": "integer", - "name": "start_line", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "text", + "name": "node_id", "description": "" - } - ] - }, + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] }, { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", "isRequired": true }, { "type": "object", - "name": "rule", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", - "isRequired": true - }, - { - "type": "string", - "name": "full_description", - "description": "" - }, - { - "type": "string or null", - "name": "help", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string or null", - "name": "help_uri", - "description": "

A link to the documentation for the rule used to detect the alert.

" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - { - "type": "array of strings or null", - "name": "tags", - "description": "" - } - ] - }, - { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - { - "type": "object", - "name": "tool", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "guid", - "description": "" + "name": "message", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "name": "timestamp", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", + "type": "string", + "name": "tree_id", + "description": "", "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string or null", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "code_scanning_alert" - }, - "reopened_by_user": { - "descriptionHtml": "

Someone reopened a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

The code scanning alert involved in the event.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "null", - "name": "dismissed_by", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "null", - "name": "dismissed_reason", - "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array", - "name": "instances", - "description": "" - }, - { - "type": "object or null", - "name": "most_recent_instance", - "description": "", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", - "isRequired": true - }, { "type": "object", - "name": "location", + "name": "base", "description": "", + "isRequired": true, "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, { "type": "string", - "name": "path", - "description": "" + "name": "ref", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "start_column", - "description": "" + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "start_line", - "description": "" + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "message", + "name": "head", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "text", - "description": "" + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true } ] }, { - "type": "string", - "name": "ref", - "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "

The code scanning alert number.

", - "isRequired": true - }, - { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "

A short description of the rule used to detect the alert.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true }, { "type": "string", - "name": "id", - "description": "

A unique identifier for the rule used to detect the alert.

", + "name": "url", + "description": "", "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "

The severity of the alert.

", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] } ] }, { - "type": "string", - "name": "state", - "description": "

State of a code scanning alert.

", + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "open", - "fixed" + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" ] }, { - "type": "object", - "name": "tool", + "type": "string", + "name": "updated_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "name", - "description": "

The name of the tool used to generate the code scanning analysis alert.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "

The version of the tool used to detect the alert.

", - "isRequired": true - } - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, - { - "type": "string", - "name": "commit_oid", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "enterprise", @@ -8089,13 +9998,6 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "ref", - "in": "body", - "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.

", - "isRequired": true - }, { "type": "object", "name": "repository", @@ -8118,301 +10020,862 @@ "organization", "app" ], - "action": "reopened_by_user", - "category": "code_scanning_alert" - } - }, - "commit_comment": { - "created": { - "descriptionHtml": "

Someone commented on a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "action": "completed", + "category": "check_suite" + }, + "requested": { + "descriptionHtml": "

Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", - "description": "

The action performed. Can be created.

", + "description": "", "isRequired": true, "enum": [ - "created" + "requested" ], "childParamsGroups": [] }, + { + "type": "object or null", + "name": "actions_meta", + "in": "body", + "description": "" + }, { "type": "object", - "name": "comment", + "name": "check_suite", "in": "body", - "description": "

The commit comment resource.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "

The text of the comment.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "

The SHA of the commit to which the comment applies.

", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

The ID of the commit comment.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "

The node ID of the commit comment.

", - "isRequired": true - }, { "type": "string or null", - "name": "path", - "description": "

The relative path of the file to which the comment applies.

", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "

The line index in the diff to which the comment applies.

", + "name": "after", + "description": "", "isRequired": true }, { "type": "object", - "name": "reactions", - "description": "", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "+1", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "integer", - "name": "eyes", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "laugh", - "description": "", + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "object or null", + "name": "owner", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] }, { "type": "string", - "name": "url", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "check_runs_url", "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, { "type": "string", - "name": "url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "user", + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" + "type": "object", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "message", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" + "name": "timestamp", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" - }, + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "latest_check_runs_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "integer", + "name": "number", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "" + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, + { + "type": "string or null", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", + "isRequired": true } ] }, @@ -8459,571 +10922,825 @@ "organization", "app" ], - "action": "created", - "category": "commit_comment" - } - }, - "create": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "action": "requested", + "category": "check_suite" + }, + "rerequested": { + "descriptionHtml": "

Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

Note: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

", "bodyParameters": [ - { - "type": "string or null", - "name": "description", - "in": "body", - "description": "

The repository's current description.

", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "master_branch", - "in": "body", - "description": "

The name of the repository's default branch (usually main).

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, { "type": "string", - "name": "ref_type", + "name": "action", "in": "body", - "description": "

The type of Git ref object created in the repository.

", + "description": "", "isRequired": true, "enum": [ - "tag", - "branch" - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "create" - } - }, - "delete": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", + "rerequested" + ], "childParamsGroups": [] }, { - "type": "string", - "name": "pusher_type", - "in": "body", - "description": "

The pusher type for the event. Can be either user or a deploy key.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "

The git ref resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "ref_type", + "type": "object or null", + "name": "actions_meta", "in": "body", - "description": "

The type of Git ref object deleted in the repository.

", - "isRequired": true, - "enum": [ - "tag", - "branch" + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "rerun_info", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "plan_id", + "description": "" + }, + { + "type": "array of strings", + "name": "job_ids", + "description": "" + } + ] + } ] }, { "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "delete" - } - }, - "dependabot_alert": { - "created": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", + "name": "check_suite", "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "after", + "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] - }, { "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "name": "app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "external_url", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "html_url", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", + "name": "name", + "description": "

The name of the GitHub app

", "isRequired": true }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", + "type": "object or null", + "name": "owner", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ + "type": "string", + "name": "following_url", + "description": "" + }, { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", + "name": "login", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, { "type": "string", "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, + "description": "", "enum": [ - "CVE", - "GHSA" + "Bot", + "User", + "Organization" ] }, { "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "name": "url", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "slug", + "description": "

The slug name of the GitHub app

" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "updated_at", + "description": "", "isRequired": true } ] }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "

The head branch name the changes are on.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "head_commit", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "author", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "

The unique package name within its ecosystem.

", + "description": "

The git author's name.

", "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" } ] }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", + "type": "object", + "name": "committer", + "description": "

Metaproperties for Git author/committer information.

", "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The git author's name.

", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } ] }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "id", + "description": "", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true } ] }, { "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", + "name": "head_sha", + "description": "

The SHA of the head commit that is being checked.

", "isRequired": true }, { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { - "type": "string", - "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "integer", + "name": "latest_check_runs_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "node_id", + "description": "", "isRequired": true }, { - "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", + "type": "array of objects", + "name": "pull_requests", + "description": "

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", + "type": "object", + "name": "head", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] }, { "type": "integer", @@ -9032,20 +11749,8 @@ "isRequired": true }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -9054,114 +11759,53 @@ "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, + { + "type": "boolean", + "name": "rerequestable", + "description": "" + }, + { + "type": "boolean", + "name": "runs_rerequestable", + "description": "" + }, { "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "name": "status", + "description": "

The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", + "requested", + "in_progress", + "completed", + "queued", null ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "

URL that points to the check suite API resource.

", "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9178,14 +11822,7 @@ }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", + "name": "repository", "in": "body", "description": "

A repository on GitHub.

", "isRequired": true, @@ -9205,12 +11842,14 @@ "organization", "app" ], - "action": "created", - "category": "dependabot_alert" - }, - "dismissed": { - "descriptionHtml": "

A Dependabot alert was manually closed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "action": "rerequested", + "category": "check_suite" + } + }, + "code_scanning_alert": { + "appeared_in_branch": { + "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9219,7 +11858,7 @@ "description": "", "isRequired": true, "enum": [ - "dismissed" + "appeared_in_branch" ], "childParamsGroups": [] }, @@ -9227,367 +11866,440 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", + "type": "object or null", + "name": "dismissed_by", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", "enum": [ - "development", - "runtime", - null + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array of object,nulls", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "type": "array of strings", + "name": "classifications", + "description": "" }, { "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] } ] }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "tool", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "appeared_in_branch", + "category": "code_scanning_alert" + }, + "closed_by_user": { + "descriptionHtml": "

Someone closed a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", "name": "dismissed_at", "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -9597,147 +12309,337 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "dismissed", + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -9753,11 +12655,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -9781,12 +12683,12 @@ "organization", "app" ], - "action": "dismissed", - "category": "dependabot_alert" + "action": "closed_by_user", + "category": "code_scanning_alert" }, - "fixed": { - "descriptionHtml": "

A manifest file change removed a vulnerability.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "created": { + "descriptionHtml": "

A code scanning alert was created in a repository.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -9795,7 +12697,7 @@ "description": "", "isRequired": true, "enum": [ - "fixed" + "created" ], "childParamsGroups": [] }, @@ -9803,350 +12705,347 @@ "type": "object", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string or null", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

The dismissal comment associated with the dismissal of the alert.

" + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, + { + "type": "null", + "name": "fixed_at", + "description": "" + }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true }, { - "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "type": "array of strings", + "name": "classifications", + "description": "" }, - { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", - "enum": [ - "development", - "runtime", - null - ] - } - ] - }, - { - "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", - "isRequired": true, - "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] + "type": "integer", + "name": "end_line", + "description": "" }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true + "name": "path", + "description": "" }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the advisory.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" }, { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true - } - ] + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true - } + "enum": [ + "open", + "dismissed", + "fixed" ] - }, + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "full_description", + "description": "" }, { "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", - "isRequired": true, - "childParamsGroups": [ + "name": "help", + "description": "" + }, { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed" + ] + }, + { + "type": "object or null", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { - "type": "string", - "name": "url", - "description": "

The REST API URL of the alert resource.

", - "isRequired": true + "type": "string or null", + "name": "updated_at", + "description": "" }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "url", + "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "code_scanning_alert" + }, + "fixed": { + "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "fixed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { @@ -10156,14 +13055,19 @@ "isRequired": true }, { - "type": "object", + "type": "object or null", "name": "dismissed_by", - "description": "

A GitHub user.

", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -10173,147 +13077,341 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "gists_url", + "description": "" }, { - "type": "string or null", + "type": "string", "name": "gravatar_id", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "following_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", "name": "starred_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "subscriptions_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "repos_url", - "description": "", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", "isRequired": true }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "commit_sha", + "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "", + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" + }, + { + "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { "type": "string", - "name": "starred_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "

The severity of the alert.

", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", "description": "" } ] }, { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", "isRequired": true, "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null + "fixed" ] }, { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] }, { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "type": "string", + "name": "url", + "description": "", "isRequired": true } ] }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10329,11 +13427,11 @@ "childParamsGroups": [] }, { - "type": "object", - "name": "enterprise", + "type": "string", + "name": "ref", "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] + "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.

", + "isRequired": true }, { "type": "object", @@ -10358,11 +13456,11 @@ "app" ], "action": "fixed", - "category": "dependabot_alert" + "category": "code_scanning_alert" }, - "reintroduced": { - "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "reopened": { + "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -10371,525 +13469,955 @@ "description": "", "isRequired": true, "enum": [ - "reintroduced" + "reopened" ], "childParamsGroups": [] }, { - "type": "object", + "type": "object or null", "name": "alert", "in": "body", - "description": "

A Dependabot alert.

", + "description": "

The code scanning alert involved in the event.

", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "number", - "description": "

The security alert number.

", + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "isRequired": true }, { "type": "string", - "name": "state", - "description": "

The state of the Dependabot alert.

", - "isRequired": true, - "enum": [ - "dismissed", - "fixed", - "open" - ] + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true }, { - "type": "object", - "name": "dependency", - "description": "

Details for the vulnerable dependency.

", - "isRequired": true, + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, { "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", + "name": "location", + "description": "", "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ { "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "manifest_path", - "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", + "isRequired": true }, { - "type": "string or null", - "name": "scope", - "description": "

The execution scope of the vulnerable dependency.

", + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, "enum": [ - "development", - "runtime", - null + "open", + "dismissed", + "fixed" ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_advisory", - "description": "

Details for the GitHub Security Advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "ghsa_id", - "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", "isRequired": true }, + { + "type": "string", + "name": "full_description", + "description": "" + }, { "type": "string or null", - "name": "cve_id", - "description": "

The unique CVE ID assigned to the advisory.

", - "isRequired": true + "name": "help", + "description": "" }, { - "type": "string", - "name": "summary", - "description": "

A short, plain text summary of the advisory.

", - "isRequired": true + "type": "string or null", + "name": "help_uri", + "description": "

A link to the documentation for the rule used to detect the alert.

" }, { "type": "string", - "name": "description", - "description": "

A long-form Markdown-supported description of the advisory.

", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", "isRequired": true }, { - "type": "array of objects", - "name": "vulnerabilities", - "description": "

Vulnerable version range information for the advisory.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "severity", - "description": "

The severity of the vulnerability.

", - "isRequired": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - { - "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] - } - ] + "type": "string", + "name": "name", + "description": "" }, { - "type": "string", + "type": "string or null", "name": "severity", - "description": "

The severity of the advisory.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] }, { - "type": "object", - "name": "cvss", - "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "score", - "description": "

The overall CVSS score of the advisory.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "vector_string", - "description": "

The full CVSS vector string for the advisory.

", - "isRequired": true - } - ] + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" }, { - "type": "array of objects", - "name": "cwes", - "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", - "isRequired": true, + "type": "string", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string or null", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "code_scanning_alert" + }, + "reopened_by_user": { + "descriptionHtml": "

Someone reopened a code scanning alert.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

The code scanning alert involved in the event.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_by", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", + "isRequired": true + }, + { + "type": "array", + "name": "instances", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", "childParamsGroups": [ { - "type": "string", - "name": "cwe_id", - "description": "

The unique CWE ID.

", - "isRequired": true + "type": "integer", + "name": "end_column", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The short, plain text name of the CWE.

", - "isRequired": true - } - ] - }, - { - "type": "array of objects", - "name": "identifiers", - "description": "

Values that identify this advisory among security information sources.

", - "isRequired": true, - "childParamsGroups": [ + "type": "integer", + "name": "end_line", + "description": "" + }, { "type": "string", - "name": "type", - "description": "

The type of advisory identifier.

", - "isRequired": true, - "enum": [ - "CVE", - "GHSA" - ] + "name": "path", + "description": "" }, { - "type": "string", - "name": "value", - "description": "

The value of the advisory identifer.

", - "isRequired": true + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" } ] }, { - "type": "array of objects", - "name": "references", - "description": "

Links to additional advisory information.

", - "isRequired": true, + "type": "object", + "name": "message", + "description": "", "childParamsGroups": [ { "type": "string", - "name": "url", - "description": "

The URL of the reference.

", - "isRequired": true + "name": "text", + "description": "" } ] }, { "type": "string", - "name": "published_at", - "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "ref", + "description": "

The full Git reference, formatted as refs/heads/<branch name>.

", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "withdrawn_at", - "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] } ] }, + { + "type": "integer", + "name": "number", + "description": "

The code scanning alert number.

", + "isRequired": true + }, { "type": "object", - "name": "security_vulnerability", - "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "name": "rule", + "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "package", - "description": "

Details for the vulnerable package.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ecosystem", - "description": "

The package's language or package management ecosystem.

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The unique package name within its ecosystem.

", - "isRequired": true - } - ] + "type": "string", + "name": "description", + "description": "

A short description of the rule used to detect the alert.

", + "isRequired": true }, { "type": "string", + "name": "id", + "description": "

A unique identifier for the rule used to detect the alert.

", + "isRequired": true + }, + { + "type": "string or null", "name": "severity", - "description": "

The severity of the vulnerability.

", + "description": "

The severity of the alert.

", "isRequired": true, "enum": [ - "low", - "medium", - "high", - "critical" + "none", + "note", + "warning", + "error", + null ] - }, + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of a code scanning alert.

", + "isRequired": true, + "enum": [ + "open", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "vulnerable_version_range", - "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "name": "name", + "description": "

The name of the tool used to generate the code scanning analysis alert.

", "isRequired": true }, { - "type": "object or null", - "name": "first_patched_version", - "description": "

Details pertaining to the package version that patches this vulnerability.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "identifier", - "description": "

The package version that patches this vulnerability.

", - "isRequired": true - } - ] + "type": "string or null", + "name": "version", + "description": "

The version of the tool used to detect the alert.

", + "isRequired": true } ] }, { "type": "string", "name": "url", - "description": "

The REST API URL of the alert resource.

", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "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.

", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened_by_user", + "category": "code_scanning_alert" + } + }, + "commit_comment": { + "created": { + "descriptionHtml": "

Someone commented on a commit.

", + "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "

The action performed. Can be created.

", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "

The commit comment resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "

The text of the comment.

", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "

The GitHub URL of the alert resource.

", + "name": "commit_id", + "description": "

The SHA of the commit to which the comment applies.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

The ID of the commit comment.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "line", + "description": "

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node ID of the commit comment.

", "isRequired": true }, { "type": "string or null", - "name": "dismissed_at", - "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "name": "path", + "description": "

The relative path of the file to which the comment applies.

", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "

The line index in the diff to which the comment applies.

", "isRequired": true }, { "type": "object", - "name": "dismissed_by", - "description": "

A GitHub user.

", - "isRequired": true, + "name": "reactions", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", - "description": "" + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "login", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "gravatar_id", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "integer", + "name": "rocket", "description": "", "isRequired": true }, { - "type": "string", - "name": "html_url", + "type": "integer", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "followers_url", + "name": "url", "description": "", "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" }, { "type": "string", "name": "following_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", "name": "gists_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "organizations_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", "name": "received_events_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { "type": "boolean", "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string or null", - "name": "dismissed_reason", - "description": "

The reason that the alert was dismissed.

", - "isRequired": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - { - "type": "string or null", - "name": "dismissed_comment", - "description": "

An optional comment associated with the alert's dismissal.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "fixed_at", - "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", - "isRequired": true } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "commit_comment" + } + }, + "create": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is created.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are created at once.

", + "bodyParameters": [ + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "

The repository's current description.

", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "installation", @@ -10897,6 +14425,13 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "master_branch", + "in": "body", + "description": "

The name of the repository's default branch (usually main).

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -10904,6 +14439,62 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object created in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "create" + } + }, + "delete": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when a Git branch or tag is deleted.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

\n

Note: This event will not occur when more than three tags are deleted at once.

", + "bodyParameters": [ { "type": "object", "name": "enterprise", @@ -10911,6 +14502,45 @@ "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "

The pusher type for the event. Can be either user or a deploy key.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "

The git ref resource.

", + "isRequired": true + }, + { + "type": "string", + "name": "ref_type", + "in": "body", + "description": "

The type of Git ref object deleted in the repository.

", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, { "type": "object", "name": "repository", @@ -10933,11 +14563,13 @@ "organization", "app" ], - "action": "reintroduced", - "category": "dependabot_alert" - }, - "reopened": { - "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "action": "default", + "category": "delete" + } + }, + "dependabot_alert": { + "created": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -10947,7 +14579,7 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "created" ], "childParamsGroups": [] }, @@ -11509,14 +15141,12 @@ "organization", "app" ], - "action": "reopened", + "action": "created", "category": "dependabot_alert" - } - }, - "deploy_key": { - "created": { - "descriptionHtml": "

A deploy key was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + }, + "dismissed": { + "descriptionHtml": "

A Dependabot alert was manually closed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11525,207 +15155,532 @@ "description": "", "isRequired": true, "enum": [ - "created" + "dismissed" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", + "name": "alert", "in": "body", - "description": "

The deploy key resource.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "added_by", - "description": "" - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "last_used", - "description": "" - }, - { - "type": "boolean", - "name": "read_only", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" + }, + { + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] }, { - "type": "boolean", - "name": "verified", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "deploy_key" - }, - "deleted": { - "descriptionHtml": "

A deploy key was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "key", - "in": "body", - "description": "

The deploy key resource.

", - "isRequired": true, - "childParamsGroups": [ + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, { - "type": "string or null", - "name": "added_by", - "description": "" + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "created_at", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "key", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string or null", - "name": "last_used", - "description": "" + "type": "string", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "boolean", - "name": "read_only", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "title", - "description": "", - "isRequired": true + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "boolean", - "name": "verified", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -11733,6 +15688,13 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", "name": "repository", @@ -11755,14 +15717,12 @@ "organization", "app" ], - "action": "deleted", - "category": "deploy_key" - } - }, - "deployment": { - "created": { - "descriptionHtml": "

A deployment was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "action": "dismissed", + "category": "dependabot_alert" + }, + "fixed": { + "descriptionHtml": "

A manifest file change removed a vulnerability.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -11771,204 +15731,415 @@ "description": "", "isRequired": true, "enum": [ - "created" + "fixed" ], "childParamsGroups": [] }, { "type": "object", - "name": "deployment", + "name": "alert", "in": "body", - "description": "

The deployment.

", + "description": "

A Dependabot alert.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", + "type": "integer", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { - "type": "object or null", - "name": "creator", - "description": "", + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "environment", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "", + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "original_environment", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or string", - "name": "payload", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "created_at", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true }, { "type": "string or null", - "name": "external_url", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", "description": "", "isRequired": true }, @@ -11979,551 +16150,125 @@ "isRequired": true }, { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", + "type": "string", + "name": "followers_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", + "name": "following_url", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "gists_url", "description": "", "isRequired": true }, { - "type": "object or null", - "name": "owner", + "type": "string", + "name": "starred_url", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" + "name": "organizations_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "updated_at", + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" } ] }, { - "type": "boolean", - "name": "production_environment", - "description": "" - }, - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "task", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "transient_environment", - "description": "" + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] }, { - "type": "string", - "name": "updated_at", - "description": "", + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", "isRequired": true }, { - "type": "string", - "name": "url", - "description": "", + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true } ] }, { "type": "object", - "name": "enterprise", + "name": "installation", "in": "body", - "description": "

An enterprise on GitHub.

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { "type": "object", - "name": "installation", + "name": "organization", "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "description": "

A GitHub organization.

", "childParamsGroups": [] }, { "type": "object", - "name": "organization", + "name": "enterprise", "in": "body", - "description": "

A GitHub organization.

", + "description": "

An enterprise on GitHub.

", "childParamsGroups": [] }, { @@ -12541,1285 +16286,1243 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - }, + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "fixed", + "category": "dependabot_alert" + }, + "reintroduced": { + "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ { - "type": "object or null", - "name": "workflow", + "type": "string", + "name": "action", "in": "body", "description": "", "isRequired": true, + "enum": [ + "reintroduced" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "badge_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "", + "name": "number", + "description": "

The security alert number.

", "isRequired": true }, { "type": "string", "name": "state", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object or null", - "name": "workflow_run", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "actor", - "description": "", + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "deleted", - "description": "" + "type": "string", + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { "type": "string or null", - "name": "email", - "description": "" - }, + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "events_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "following_url", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] }, { "type": "string", - "name": "html_url", - "description": "" + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "name", - "description": "" + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true + } + ] }, { - "type": "string", - "name": "node_id", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } ] - }, - { - "type": "string", - "name": "url", - "description": "" } ] }, { "type": "string", - "name": "artifacts_url", - "description": "" - }, - { - "type": "string", - "name": "cancel_url", - "description": "" - }, - { - "type": "integer", - "name": "check_suite_id", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "check_suite_node_id", - "description": "", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, - { - "type": "string", - "name": "check_suite_url", - "description": "" - }, - { - "type": "string or null", - "name": "conclusion", - "description": "", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - null - ] - }, { "type": "string", "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "display_title", - "description": "", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "event", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "head_branch", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, - { - "type": "null", - "name": "head_commit", - "description": "" - }, { "type": "object", - "name": "head_repository", - "description": "", + "name": "dismissed_by", + "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "archive_url", + "type": "string or null", + "name": "name", "description": "" }, { - "type": "string", - "name": "assignees_url", + "type": "string or null", + "name": "email", "description": "" }, { "type": "string", - "name": "blobs_url", - "description": "" + "name": "login", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "branches_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "collaborators_url", - "description": "" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "commits_url", - "description": "" + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "compare_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contents_url", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "forks_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "full_name", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_commits_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_refs_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "git_tags_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_comment_url", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "type", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "issues_url", - "description": "" + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", + "name": "starred_at", "description": "" - }, + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reintroduced", + "category": "dependabot_alert" + }, + "reopened": { + "descriptionHtml": "

A Dependabot alert was manually reopened.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "

A Dependabot alert.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "

The security alert number.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the Dependabot alert.

", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "

Details for the vulnerable dependency.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "labels_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "manifest_path", + "description": "

The full path to the dependency manifest file, relative to the root of the repository.

" }, { - "type": "string", - "name": "merges_url", - "description": "" - }, + "type": "string or null", + "name": "scope", + "description": "

The execution scope of the vulnerable dependency.

", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "

Details for the GitHub Security Advisory.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "milestones_url", - "description": "" + "name": "ghsa_id", + "description": "

The unique GitHub Security Advisory ID assigned to the advisory.

", + "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "string or null", + "name": "cve_id", + "description": "

The unique CVE ID assigned to the advisory.

", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "summary", + "description": "

A short, plain text summary of the advisory.

", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" + "name": "description", + "description": "

A long-form Markdown-supported description of the advisory.

", + "isRequired": true }, { - "type": "object", - "name": "owner", - "description": "", + "type": "array of objects", + "name": "vulnerabilities", + "description": "

Vulnerable version range information for the advisory.

", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" - }, + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "

The severity of the advisory.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "

Details for the advisory pertaining to the Common Vulnerability Scoring System.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "repos_url", - "description": "" + "type": "number", + "name": "score", + "description": "

The overall CVSS score of the advisory.

", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" - }, + "type": "string or null", + "name": "vector_string", + "description": "

The full CVSS vector string for the advisory.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "

Details for the advisory pertaining to Common Weakness Enumeration.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "starred_url", - "description": "" + "name": "cwe_id", + "description": "

The unique CWE ID.

", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" - }, + "name": "name", + "description": "

The short, plain text name of the CWE.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "

Values that identify this advisory among security information sources.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", "name": "type", - "description": "" + "description": "

The type of advisory identifier.

", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] }, { "type": "string", - "name": "url", - "description": "" + "name": "value", + "description": "

The value of the advisory identifer.

", + "isRequired": true } ] }, { - "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "type": "array of objects", + "name": "references", + "description": "

Links to additional advisory information.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "

The URL of the reference.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "statuses_url", - "description": "" + "name": "published_at", + "description": "

The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { "type": "string", - "name": "subscribers_url", - "description": "" + "name": "updated_at", + "description": "

The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true }, { - "type": "string", - "name": "subscription_url", - "description": "" - }, + "type": "string or null", + "name": "withdrawn_at", + "description": "

The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "security_vulnerability", + "description": "

Details pertaining to one vulnerable version range for the advisory.

", + "isRequired": true, + "childParamsGroups": [ { - "type": "string", - "name": "tags_url", - "description": "" + "type": "object", + "name": "package", + "description": "

Details for the vulnerable package.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "

The package's language or package management ecosystem.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The unique package name within its ecosystem.

", + "isRequired": true + } + ] }, { "type": "string", - "name": "teams_url", - "description": "" + "name": "severity", + "description": "

The severity of the vulnerability.

", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, { "type": "string", - "name": "trees_url", - "description": "" + "name": "vulnerable_version_range", + "description": "

Conditions that identify vulnerable versions of this vulnerability's package.

", + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" + "type": "object or null", + "name": "first_patched_version", + "description": "

Details pertaining to the package version that patches this vulnerability.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "

The package version that patches this vulnerability.

", + "isRequired": true + } + ] } ] }, { "type": "string", - "name": "head_sha", - "description": "", + "name": "url", + "description": "

The REST API URL of the alert resource.

", "isRequired": true }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", + "description": "

The GitHub URL of the alert resource.

", "isRequired": true }, { "type": "string", - "name": "jobs_url", - "description": "" - }, - { - "type": "string", - "name": "logs_url", - "description": "" - }, - { - "type": "string", - "name": "name", - "description": "", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", + "name": "updated_at", + "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "string", - "name": "path", - "description": "", + "type": "string or null", + "name": "dismissed_at", + "description": "

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", "isRequired": true }, { - "type": "null", - "name": "previous_attempt_url", - "description": "" - }, - { - "type": "array of objects", - "name": "pull_requests", - "description": "", + "type": "object", + "name": "dismissed_by", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [ { - "type": "object", - "name": "base", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "name", + "description": "" }, { - "type": "object", - "name": "head", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "ref", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repo", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "sha", - "description": "", - "isRequired": true - } - ] + "type": "string or null", + "name": "email", + "description": "" }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "integer", - "name": "number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "node_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "array of objects or null", - "name": "referenced_workflows", - "description": "", - "childParamsGroups": [ + }, { "type": "string", - "name": "path", + "name": "avatar_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "ref", - "description": "" - }, - { - "type": "string", - "name": "sha", + "type": "string or null", + "name": "gravatar_id", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "archive_url", - "description": "" - }, - { - "type": "string", - "name": "assignees_url", - "description": "" - }, - { - "type": "string", - "name": "blobs_url", - "description": "" - }, - { - "type": "string", - "name": "branches_url", - "description": "" - }, - { - "type": "string", - "name": "collaborators_url", - "description": "" - }, - { - "type": "string", - "name": "comments_url", - "description": "" - }, - { - "type": "string", - "name": "commits_url", - "description": "" - }, - { - "type": "string", - "name": "compare_url", - "description": "" - }, - { - "type": "string", - "name": "contents_url", - "description": "" - }, - { - "type": "string", - "name": "contributors_url", - "description": "" - }, - { - "type": "string", - "name": "deployments_url", - "description": "" - }, - { - "type": "null", - "name": "description", - "description": "" - }, - { - "type": "string", - "name": "downloads_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "boolean", - "name": "fork", - "description": "" - }, - { - "type": "string", - "name": "forks_url", - "description": "" - }, - { - "type": "string", - "name": "full_name", - "description": "" - }, - { - "type": "string", - "name": "git_commits_url", - "description": "" - }, - { - "type": "string", - "name": "git_refs_url", - "description": "" - }, - { - "type": "string", - "name": "git_tags_url", - "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "" + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", - "description": "" + "description": "", + "isRequired": true }, { "type": "string", - "name": "issue_events_url", - "description": "" + "name": "followers_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "" + "name": "following_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "keys_url", - "description": "" + "name": "gists_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "labels_url", - "description": "" + "name": "starred_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "languages_url", - "description": "" + "name": "subscriptions_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "merges_url", - "description": "" + "name": "organizations_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "milestones_url", - "description": "" + "name": "repos_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "received_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "notifications_url", - "description": "" - }, - { - "type": "object", - "name": "owner", + "name": "type", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "" - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "boolean", - "name": "private", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "" - }, - { - "type": "string", - "name": "releases_url", - "description": "" - }, - { - "type": "string", - "name": "stargazers_url", - "description": "" + "name": "site_admin", + "description": "", + "isRequired": true }, { "type": "string", - "name": "statuses_url", - "description": "" - }, - { - "type": "string", - "name": "subscribers_url", - "description": "" - }, - { - "type": "string", - "name": "subscription_url", - "description": "" - }, - { - "type": "string", - "name": "tags_url", - "description": "" - }, - { - "type": "string", - "name": "teams_url", - "description": "" - }, - { - "type": "string", - "name": "trees_url", - "description": "" - }, - { - "type": "string", - "name": "url", + "name": "starred_at", "description": "" } ] }, { - "type": "string", - "name": "rerun_url", + "type": "string or null", + "name": "dismissed_reason", + "description": "

The reason that the alert was dismissed.

", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "

An optional comment associated with the alert's dismissal.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "dependabot_alert" + } + }, + "deploy_key": { + "created": { + "descriptionHtml": "

A deploy key was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "added_by", "description": "" }, { - "type": "integer", - "name": "run_attempt", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "run_number", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "run_started_at", + "name": "key", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "", - "isRequired": true, - "enum": [ - "requested", - "in_progress", - "completed", - "queued", - "waiting", - "pending" - ] + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "object or null", - "name": "triggering_actor", + "type": "boolean", + "name": "read_only", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "title", "description": "", "isRequired": true }, @@ -13830,17 +17533,35 @@ "isRequired": true }, { - "type": "integer", - "name": "workflow_id", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "workflow_url", - "description": "" } ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] } ], "availability": [ @@ -13849,13 +17570,11 @@ "app" ], "action": "created", - "category": "deployment" - } - }, - "deployment_status": { - "created": { - "descriptionHtml": "

A new deployment status was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "category": "deploy_key" + }, + "deleted": { + "descriptionHtml": "

A deploy key was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -13864,108 +17583,134 @@ "description": "", "isRequired": true, "enum": [ - "created" + "deleted" ], "childParamsGroups": [] }, { - "type": "object or null", - "name": "check_run", + "type": "object", + "name": "enterprise", "in": "body", - "description": "", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "

The deploy key resource.

", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", - "name": "completed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "conclusion", - "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", - "isRequired": true, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required", - "stale", - "skipped", - null - ] + "name": "added_by", + "description": "" }, { "type": "string", - "name": "details_url", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "external_id", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "head_sha", - "description": "

The SHA of the commit that is being checked.

", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", + "name": "key", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

The id of the check.

", - "isRequired": true + "type": "string or null", + "name": "last_used", + "description": "" }, { - "type": "string", - "name": "name", - "description": "

The name of the check run.

", + "type": "boolean", + "name": "read_only", + "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { "type": "string", - "name": "started_at", + "name": "url", "description": "", "isRequired": true }, { - "type": "string", - "name": "status", - "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", - "isRequired": true, - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "pending" - ] - }, - { - "type": "string", - "name": "url", + "type": "boolean", + "name": "verified", "description": "", "isRequired": true } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "deploy_key" + } + }, + "deployment": { + "created": { + "descriptionHtml": "

A deployment was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "deployment", @@ -14130,7 +17875,7 @@ "isRequired": true }, { - "type": "null or string or object", + "type": "object or string", "name": "payload", "description": "", "isRequired": true @@ -14696,718 +18441,6 @@ } ] }, - { - "type": "object", - "name": "deployment_status", - "in": "body", - "description": "

The deployment status.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "creator", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "deployment_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "

The optional human-readable description added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "environment", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "environment_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "log_url", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", - "childParamsGroups": [ - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "events", - "description": "

The list of events for the GitHub app

" - }, - { - "type": "string or null", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "id", - "description": "

Unique identifier of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the GitHub app

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "

The set of permissions for the GitHub app

", - "childParamsGroups": [ - { - "type": "string", - "name": "actions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "checks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "content_references", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "contents", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "deployments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "emails", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "environments", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "issues", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "keys", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "members", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "metadata", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_administration", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_plan", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_self_hosted_runners", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "organization_user_blocking", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "packages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pages", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "pull_requests", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_hooks", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "repository_projects", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secret_scanning_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "secrets", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_events", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "security_scanning_alert", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "single_file", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "statuses", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "team_discussions", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "vulnerability_alerts", - "description": "", - "enum": [ - "read", - "write" - ] - }, - { - "type": "string", - "name": "workflows", - "description": "", - "enum": [ - "read", - "write" - ] - } - ] - }, - { - "type": "string", - "name": "slug", - "description": "

The slug name of the GitHub app

" - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The new state. Can be pending, success, failure, or error.

", - "isRequired": true - }, - { - "type": "string", - "name": "target_url", - "description": "

The optional link added to the status.

", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "object", "name": "enterprise", @@ -15450,6 +18483,7 @@ "name": "workflow", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -15518,6 +18552,7 @@ "name": "workflow_run", "in": "body", "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "object or null", @@ -15679,8 +18714,7 @@ "timed_out", "action_required", "stale", - null, - "startup_failure" + null ] }, { @@ -16604,7 +19638,6 @@ "type": "object or null", "name": "triggering_actor", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -16752,13 +19785,13 @@ "app" ], "action": "created", - "category": "deployment_status" + "category": "deployment" } }, - "discussion": { - "answered": { - "descriptionHtml": "

A comment on the discussion was marked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "deployment_status": { + "created": { + "descriptionHtml": "

A new deployment status was created.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -16767,55 +19800,55 @@ "description": "", "isRequired": true, "enum": [ - "answered" + "created" ], "childParamsGroups": [] }, { - "type": "object", - "name": "answer", + "type": "object or null", + "name": "check_run", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

", "isRequired": true, "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + "skipped", + null ] }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", + "name": "details_url", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "external_id", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", - "description": "", + "type": "string", + "name": "head_sha", + "description": "

The SHA of the commit that is being checked.

", "isRequired": true }, { @@ -16827,7 +19860,13 @@ { "type": "integer", "name": "id", - "description": "", + "description": "

The id of the check.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the check run.

", "isRequired": true }, { @@ -16837,93 +19876,48 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "string", + "name": "started_at", "description": "", "isRequired": true }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } + "type": "string", + "name": "status", + "description": "

The current status of the check run. Can be queued, in_progress, or completed.

", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "pending" ] }, { "type": "string", - "name": "repository_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "

The deployment.

", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "updated_at", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "user", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17040,113 +20034,145 @@ "description": "" } ] - } - ] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "answered", - "category": "discussion" - }, - "category_changed": { - "descriptionHtml": "

The category of a discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "category_changed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "category", + "type": "string or null", + "name": "description", "description": "", - "isRequired": true, + "isRequired": true + }, + { + "type": "string", + "name": "environment", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "", + "isRequired": true + }, + { + "type": "null or string or object", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "object", - "name": "from", + "type": "string or null", + "name": "created_at", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" }, { "type": "integer", @@ -17155,16 +20181,15 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", "name": "name", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", @@ -17172,51 +20197,457 @@ "description": "" }, { - "type": "integer", - "name": "repository_id", + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "slug", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] }, { "type": "string", - "name": "updated_at", + "name": "administration", "description": "", - "isRequired": true + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] } ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true } ] + }, + { + "type": "boolean", + "name": "production_environment", + "description": "" + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true } ] }, { "type": "object", - "name": "discussion", + "name": "deployment_status", "in": "body", - "description": "", + "description": "

The deployment status.

", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, { "type": "object or null", - "name": "answer_chosen_by", + "name": "creator", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17334,118 +20765,28 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, { "type": "string", - "name": "body", + "name": "deployment_url", "description": "", "isRequired": true }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", + "type": "string", + "name": "description", + "description": "

The optional human-readable description added to the status.

", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "environment", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "environment_url", + "description": "" }, { "type": "integer", @@ -17454,10 +20795,9 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "string", + "name": "log_url", + "description": "" }, { "type": "string", @@ -17466,302 +20806,543 @@ "isRequired": true }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", + "type": "string or null", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app

" }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "external_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" }, { "type": "string", "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", - "description": "", + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", "isRequired": true }, { "type": "string", "name": "name", - "description": "" + "description": "

The name of the GitHub app

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "description": "", + "isRequired": true }, { - "type": "string", - "name": "type", + "type": "object or null", + "name": "owner", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } ] }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "category_changed", - "category": "discussion" - }, - "created": { - "descriptionHtml": "

A discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The new state. Can be pending, success, failure, or error.

", + "isRequired": true + }, + { + "type": "string", + "name": "target_url", + "description": "

The optional link added to the status.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "object", @@ -17799,53 +21380,84 @@ "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "discussion" - }, - "deleted": { - "descriptionHtml": "

A discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] }, { - "type": "object", - "name": "discussion", + "type": "object or null", + "name": "workflow", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "badge_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "workflow_run", + "in": "body", + "description": "", + "childParamsGroups": [ { "type": "object or null", - "name": "answer_chosen_by", + "name": "actor", "description": "", "isRequired": true, "childParamsGroups": [ @@ -17963,525 +21575,187 @@ } ] }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "artifacts_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "name": "cancel_url", + "description": "" }, { "type": "integer", - "name": "comments", + "name": "check_suite_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "check_suite_node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "check_suite_url", + "description": "" }, { - "type": "boolean", - "name": "locked", + "type": "string or null", + "name": "conclusion", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" + ] }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, { "type": "string", - "name": "repository_url", + "name": "display_title", "description": "", "isRequired": true }, { "type": "string", - "name": "state", + "name": "event", "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" + "isRequired": true }, { "type": "string", - "name": "title", + "name": "head_branch", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "null", + "name": "head_commit", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "object", + "name": "head_repository", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", + "name": "archive_url", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "assignees_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "blobs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "branches_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "collaborators_url", "description": "" }, { "type": "string", - "name": "html_url", + "name": "comments_url", "description": "" }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, { "type": "string", - "name": "name", + "name": "commits_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "compare_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "contents_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "contributors_url", "description": "" }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", + "name": "deployments_url", "description": "" }, { - "type": "string", - "name": "starred_url", + "type": "null", + "name": "description", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "downloads_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "deleted", - "category": "discussion" - }, - "edited": { - "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", + "name": "events_url", "description": "" }, { "type": "boolean", - "name": "deleted", + "name": "fork", "description": "" }, { - "type": "string or null", - "name": "email", + "type": "string", + "name": "forks_url", "description": "" }, { "type": "string", - "name": "events_url", + "name": "full_name", "description": "" }, { "type": "string", - "name": "followers_url", + "name": "git_commits_url", "description": "" }, { "type": "string", - "name": "following_url", + "name": "git_refs_url", "description": "" }, { "type": "string", - "name": "gists_url", + "name": "git_tags_url", "description": "" }, { "type": "string", - "name": "gravatar_id", + "name": "hooks_url", "description": "" }, { @@ -18492,124 +21766,366 @@ { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true + "description": "" }, { "type": "string", - "name": "name", + "name": "issue_comment_url", "description": "" }, { "type": "string", - "name": "node_id", + "name": "issue_events_url", "description": "" }, { "type": "string", - "name": "organizations_url", + "name": "issues_url", "description": "" }, { "type": "string", - "name": "received_events_url", + "name": "keys_url", "description": "" }, { "type": "string", - "name": "repos_url", + "name": "labels_url", "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "languages_url", "description": "" }, { "type": "string", - "name": "starred_url", + "name": "merges_url", "description": "" }, { "type": "string", - "name": "subscriptions_url", + "name": "milestones_url", "description": "" }, { "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "name": "name", + "description": "" }, { "type": "string", - "name": "url", + "name": "node_id", "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "notifications_url", + "description": "" }, { - "type": "string", - "name": "emoji", + "type": "object", + "name": "owner", "description": "", - "isRequired": true - }, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "jobs_url", + "description": "" + }, + { + "type": "string", + "name": "logs_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "previous_attempt_url", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, { "type": "integer", "name": "id", @@ -18617,69 +22133,636 @@ "isRequired": true }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects or null", + "name": "referenced_workflows", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "" + }, + { + "type": "string", + "name": "sha", "description": "", "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" }, { "type": "string", "name": "node_id", "description": "" }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "rerun_url", + "description": "" + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + { + "type": "object or null", + "name": "triggering_actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, { "type": "integer", - "name": "repository_id", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "slug", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "updated_at", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, { "type": "integer", - "name": "comments", + "name": "workflow_id", "description": "", "isRequired": true }, { "type": "string", - "name": "created_at", + "name": "workflow_url", + "description": "" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "deployment_status" + } + }, + "discussion": { + "answered": { + "descriptionHtml": "

A comment on the discussion was marked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "answered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "answer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", "description": "", "isRequired": true }, { "type": "string", - "name": "html_url", + "name": "created_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "discussion_id", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", "description": "", "isRequired": true }, @@ -18690,8 +22773,8 @@ "isRequired": true }, { - "type": "integer", - "name": "number", + "type": "null", + "name": "parent_id", "description": "", "isRequired": true }, @@ -18768,29 +22851,6 @@ "description": "", "isRequired": true }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, { "type": "string", "name": "updated_at", @@ -18919,6 +22979,13 @@ } ] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "enterprise", @@ -18962,11 +23029,11 @@ "organization", "app" ], - "action": "edited", + "action": "answered", "category": "discussion" }, - "labeled": { - "descriptionHtml": "

A label was added to a discussion.

", + "category_changed": { + "descriptionHtml": "

The category of a discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -18976,10 +23043,94 @@ "description": "", "isRequired": true, "enum": [ - "labeled" + "category_changed" ], "childParamsGroups": [] }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, { "type": "object", "name": "discussion", @@ -19142,7 +23293,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -19496,58 +23647,7 @@ }, { "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", + "name": "organization", "in": "body", "description": "

A GitHub organization.

", "childParamsGroups": [] @@ -19574,11 +23674,11 @@ "organization", "app" ], - "action": "labeled", + "action": "category_changed", "category": "discussion" }, - "locked": { - "descriptionHtml": "

A discussion was locked.

", + "created": { + "descriptionHtml": "

A discussion was created.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19588,7 +23688,7 @@ "description": "", "isRequired": true, "enum": [ - "locked" + "created" ], "childParamsGroups": [] }, @@ -19642,11 +23742,11 @@ "organization", "app" ], - "action": "locked", + "action": "created", "category": "discussion" }, - "pinned": { - "descriptionHtml": "

A discussion was pinned.

", + "deleted": { + "descriptionHtml": "

A discussion was deleted.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -19656,7 +23756,7 @@ "description": "", "isRequired": true, "enum": [ - "pinned" + "deleted" ], "childParamsGroups": [] }, @@ -20203,11 +24303,11 @@ "organization", "app" ], - "action": "pinned", + "action": "deleted", "category": "discussion" }, - "transferred": { - "descriptionHtml": "

A discussion was transferred to another repository.

", + "edited": { + "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -20217,7 +24317,7 @@ "description": "", "isRequired": true, "enum": [ - "transferred" + "edited" ], "childParamsGroups": [] }, @@ -20226,258 +24326,104 @@ "name": "changes", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "object", - "name": "new_discussion", + "name": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", + "type": "string", + "name": "from", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "object", + "name": "title", + "description": "", + "childParamsGroups": [ { - "type": "string or null", - "name": "answer_chosen_at", + "type": "string", + "name": "from", "description": "", "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + "type": "boolean", + "name": "deleted", + "description": "" }, { "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "name": "email", + "description": "" }, { "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "name": "events_url", + "description": "" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", @@ -20486,979 +24432,490 @@ "isRequired": true }, { - "type": "boolean", - "name": "locked", + "type": "string", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "node_id", + "description": "" }, { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "string", + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] + "name": "repos_url", + "description": "" }, { - "type": "string", - "name": "timeline_url", + "type": "boolean", + "name": "site_admin", "description": "" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "object or null", - "name": "user", + "type": "string", + "name": "type", "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "new_repository", - "description": "

A git repository

", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "boolean", - "name": "allow_auto_merge", - "description": "

Whether to allow auto-merge for pull requests.

", - "default": false - }, - { - "type": "boolean", - "name": "allow_forking", - "description": "

Whether to allow private forks

" - }, - { - "type": "boolean", - "name": "allow_merge_commit", - "description": "

Whether to allow merge commits for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_rebase_merge", - "description": "

Whether to allow rebase merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_squash_merge", - "description": "

Whether to allow squash merges for pull requests.

", - "default": true - }, - { - "type": "boolean", - "name": "allow_update_branch", - "description": "" - }, { "type": "string", - "name": "archive_url", + "name": "created_at", "description": "", "isRequired": true }, - { - "type": "boolean", - "name": "archived", - "description": "

Whether the repository is archived.

", - "isRequired": true, - "default": false - }, { "type": "string", - "name": "assignees_url", + "name": "description", "description": "", "isRequired": true }, { "type": "string", - "name": "blobs_url", + "name": "emoji", "description": "", "isRequired": true }, { - "type": "string", - "name": "branches_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "clone_url", + "type": "boolean", + "name": "is_answerable", "description": "", "isRequired": true }, { "type": "string", - "name": "collaborators_url", + "name": "name", "description": "", "isRequired": true }, { "type": "string", - "name": "comments_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { - "type": "string", - "name": "commits_url", + "type": "integer", + "name": "repository_id", "description": "", "isRequired": true }, { "type": "string", - "name": "compare_url", + "name": "slug", "description": "", "isRequired": true }, { "type": "string", - "name": "contents_url", + "name": "updated_at", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ { - "type": "string", - "name": "contributors_url", + "type": "integer", + "name": "+1", "description": "", "isRequired": true }, { - "type": "integer or string", - "name": "created_at", + "type": "integer", + "name": "-1", "description": "", "isRequired": true }, { - "type": "string", - "name": "default_branch", - "description": "

The default branch of the repository.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "delete_branch_on_merge", - "description": "

Whether to delete head branches when pull requests are merged

", - "default": false - }, - { - "type": "string", - "name": "deployments_url", + "type": "integer", + "name": "confused", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "description", + "type": "integer", + "name": "eyes", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "disabled", - "description": "

Returns whether or not this repository is disabled.

" - }, - { - "type": "string", - "name": "downloads_url", + "type": "integer", + "name": "heart", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "integer", + "name": "hooray", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "fork", + "type": "integer", + "name": "laugh", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks", + "name": "rocket", "description": "", "isRequired": true }, { "type": "integer", - "name": "forks_count", + "name": "total_count", "description": "", "isRequired": true }, { "type": "string", - "name": "forks_url", + "name": "url", "description": "", "isRequired": true - }, + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "avatar_url", + "description": "" }, { - "type": "string", - "name": "git_commits_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "deleted", + "description": "" }, { - "type": "string", - "name": "git_refs_url", - "description": "", - "isRequired": true + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "git_tags_url", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "git_url", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_downloads", - "description": "

Whether downloads are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_issues", - "description": "

Whether issues are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_pages", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "has_projects", - "description": "

Whether projects are enabled.

", - "isRequired": true, - "default": true - }, - { - "type": "boolean", - "name": "has_wiki", - "description": "

Whether the wiki is enabled.

", - "isRequired": true, - "default": true + "name": "followers_url", + "description": "" }, { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false + "type": "string", + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "homepage", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "hooks_url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_template", - "description": "" - }, - { - "type": "string", - "name": "issue_comment_url", "description": "", "isRequired": true }, { "type": "string", - "name": "issue_events_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "issues_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "keys_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { - "type": "string or null", - "name": "language", - "description": "", - "isRequired": true + "type": "string", + "name": "received_events_url", + "description": "" }, { "type": "string", - "name": "languages_url", - "description": "", - "isRequired": true + "name": "repos_url", + "description": "" }, { - "type": "object or null", - "name": "license", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "key", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "spdx_id", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "url", - "description": "", - "isRequired": true - } - ] + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "master_branch", + "name": "starred_url", "description": "" }, { "type": "string", - "name": "merges_url", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { "type": "string", - "name": "milestones_url", + "name": "type", "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "mirror_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "notifications_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "open_issues_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organization", - "description": "" - }, - { - "type": "object or null", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "permissions", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "admin", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "maintain", - "description": "" - }, - { - "type": "boolean", - "name": "pull", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "push", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "triage", - "description": "" - } + "enum": [ + "Bot", + "User", + "Organization" ] }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "" - }, - { - "type": "string", - "name": "pulls_url", - "description": "", - "isRequired": true - }, - { - "type": "null or integer or string or integer or string", - "name": "pushed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "releases_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "role_name", - "description": "" - }, - { - "type": "integer", - "name": "size", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "ssh_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "stargazers", - "description": "" - }, - { - "type": "integer", - "name": "stargazers_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "stargazers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "statuses_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscribers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscription_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "svn_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "tags_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "teams_url", - "description": "", - "isRequired": true - }, - { - "type": "array of strings", - "name": "topics", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "trees_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, { "type": "string", "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "visibility", - "description": "", - "isRequired": true, - "enum": [ - "public", - "private", - "internal" - ] - }, - { - "type": "integer", - "name": "watchers", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "watchers_count", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "web_commit_signoff_required", - "description": "

Whether to require contributors to sign off on web-based commits

" + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "discussion" + }, + "labeled": { + "descriptionHtml": "

A label was added to a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "labeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -21621,7 +25078,7 @@ ] }, { - "type": "string", + "type": "string or null", "name": "body", "description": "", "isRequired": true @@ -21973,6 +25430,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -22002,11 +25510,11 @@ "organization", "app" ], - "action": "transferred", + "action": "labeled", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "locked": { + "descriptionHtml": "

A discussion was locked.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22016,7 +25524,7 @@ "description": "", "isRequired": true, "enum": [ - "unanswered" + "locked" ], "childParamsGroups": [] }, @@ -22041,278 +25549,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "old_answer", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, { "type": "object", "name": "organization", @@ -22333,6 +25569,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -22341,11 +25578,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "locked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "

A label was removed from a discussion.

", + "pinned": { + "descriptionHtml": "

A discussion was pinned.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -22355,7 +25592,7 @@ "description": "", "isRequired": true, "enum": [ - "unlabeled" + "pinned" ], "childParamsGroups": [] }, @@ -22873,125 +26110,6 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, - { - "type": "object", - "name": "label", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unlabeled", - "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "

A discussion was unlocked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "unlocked" - ], - "childParamsGroups": [] - }, - { - "type": "", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, { "type": "object", "name": "organization", @@ -23021,11 +26139,11 @@ "organization", "app" ], - "action": "unlocked", + "action": "pinned", "category": "discussion" }, - "unpinned": { - "descriptionHtml": "

A discussion was unpinned.

", + "transferred": { + "descriptionHtml": "

A discussion was transferred to another repository.

", "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { @@ -23035,852 +26153,1254 @@ "description": "", "isRequired": true, "enum": [ - "unpinned" + "transferred" ], "childParamsGroups": [] }, { "type": "object", - "name": "discussion", + "name": "changes", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", + "type": "object", + "name": "new_discussion", "description": "", "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "active_lock_reason", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "string or null", + "name": "answer_chosen_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", + "type": "object or null", + "name": "answer_chosen_by", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, { - "type": "string", - "name": "created_at", + "type": "string or null", + "name": "answer_html_url", "description": "", "isRequired": true }, { "type": "string", - "name": "description", - "description": "", - "isRequired": true + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "emoji", + "name": "body", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "boolean", - "name": "is_answerable", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { "type": "string", - "name": "name", + "name": "created_at", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "slug", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "integer", - "name": "confused", + "name": "number", "description": "", "isRequired": true }, { - "type": "integer", - "name": "eyes", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { - "type": "integer", - "name": "heart", + "type": "string", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "state", "description": "", - "isRequired": true + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "timeline_url", + "description": "" }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "title", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "updated_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "object or null", + "name": "user", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "open", - "locked", - "converting", - "transferring" - ] - }, - { - "type": "string", - "name": "timeline_url", - "description": "" - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", + "type": "object", + "name": "new_repository", + "description": "

A git repository

", "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "allow_forking", + "description": "

Whether to allow private forks

" }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true }, { - "type": "string", - "name": "followers_url", + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", "description": "" }, { "type": "string", - "name": "following_url", - "description": "" + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "assignees_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gravatar_id", - "description": "" + "name": "blobs_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" + "name": "branches_url", + "description": "", + "isRequired": true }, { - "type": "integer", - "name": "id", + "type": "string", + "name": "clone_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "collaborators_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" + "name": "comments_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "commits_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "compare_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "contents_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "contributors_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false }, { "type": "string", - "name": "type", + "name": "deployments_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "unpinned", - "category": "discussion" - } - }, - "discussion_comment": { - "created": { - "descriptionHtml": "

A comment on a discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "comment", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "

How the author is associated with the repository.

", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, { - "type": "integer", - "name": "+1", + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "-1", + "type": "string", + "name": "events_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "confused", + "type": "boolean", + "name": "fork", "description": "", "isRequired": true }, { "type": "integer", - "name": "eyes", + "name": "forks", "description": "", "isRequired": true }, { "type": "integer", - "name": "heart", + "name": "forks_count", "description": "", "isRequired": true }, { - "type": "integer", - "name": "hooray", + "type": "string", + "name": "forks_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "laugh", + "type": "string", + "name": "full_name", "description": "", "isRequired": true }, { - "type": "integer", - "name": "rocket", + "type": "string", + "name": "git_commits_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "total_count", + "type": "string", + "name": "git_refs_url", "description": "", "isRequired": true }, { "type": "string", - "name": "url", + "name": "git_tags_url", "description": "", "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { "type": "string", - "name": "avatar_url", - "description": "" + "name": "git_url", + "description": "", + "isRequired": true }, { "type": "boolean", - "name": "deleted", - "description": "" + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string or null", - "name": "email", - "description": "" + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "events_url", - "description": "" + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "following_url", - "description": "" + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true }, { - "type": "string", - "name": "gists_url", - "description": "" + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true }, { "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "name": "hooks_url", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "html_url", "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "" + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true }, { - "type": "string", - "name": "node_id", + "type": "boolean", + "name": "is_template", "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "issue_comment_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "issue_events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" + "name": "issues_url", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "starred_url", - "description": "" + "name": "labels_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true }, { "type": "string", - "name": "type", + "name": "languages_url", "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] + "isRequired": true }, { - "type": "string", - "name": "url", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "discussion", - "in": "body", - "description": "", - "isRequired": true, + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string or null", @@ -24037,7 +27557,7 @@ ] }, { - "type": "string or null", + "type": "string", "name": "body", "description": "", "isRequired": true @@ -24418,12 +27938,12 @@ "organization", "app" ], - "action": "created", - "category": "discussion_comment" + "action": "transferred", + "category": "discussion" }, - "deleted": { - "descriptionHtml": "

A comment on a discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unanswered": { + "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -24432,13 +27952,34 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "unanswered" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "comment", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "old_answer", "in": "body", "description": "", "isRequired": true, @@ -24502,7 +28043,7 @@ "isRequired": true }, { - "type": "integer or null", + "type": "null", "name": "parent_id", "description": "", "isRequired": true @@ -24511,7 +28052,6 @@ "type": "object", "name": "reactions", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "integer", @@ -24709,6 +28249,52 @@ } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unanswered", + "category": "discussion" + }, + "unlabeled": { + "descriptionHtml": "

A label was removed from a discussion.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "discussion", @@ -25223,6 +28809,57 @@ "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -25252,12 +28889,12 @@ "organization", "app" ], - "action": "deleted", - "category": "discussion_comment" + "action": "unlabeled", + "category": "discussion" }, - "edited": { - "descriptionHtml": "

A comment on a discussion was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "unlocked": { + "descriptionHtml": "

A discussion was unlocked.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -25266,33 +28903,641 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "unlocked" ], "childParamsGroups": [] }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, { "type": "object", - "name": "changes", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlocked", + "category": "discussion" + }, + "unpinned": { + "descriptionHtml": "

A discussion was unpinned.

", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unpinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "type": "object", + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", "name": "body", "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "from", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", "description": "", "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" } ] } ] }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unpinned", + "category": "discussion" + } + }, + "discussion_comment": { + "created": { + "descriptionHtml": "

A comment on a discussion was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "comment", @@ -26109,74 +30354,12 @@ "organization", "app" ], - "action": "edited", + "action": "created", "category": "discussion_comment" - } - }, - "fork": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "forkee", - "in": "body", - "description": "

The created repository resource.

", - "isRequired": true - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "business", - "repository", - "organization", - "app" - ], - "action": "default", - "category": "fork" - } - }, - "github_app_authorization": { - "revoked": { - "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + }, + "deleted": { + "descriptionHtml": "

A comment on a discussion was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26185,215 +30368,67 @@ "description": "", "isRequired": true, "enum": [ - "revoked" + "deleted" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "revoked", - "category": "github_app_authorization" - } - }, - "gollum": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "pages", + "name": "comment", "in": "body", - "description": "

The pages that were updated.

", + "description": "", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "action", - "description": "

The action that was performed on the page. Can be created or edited.

", + "name": "author_association", + "description": "

How the author is associated with the repository.

", "isRequired": true, "enum": [ - "created", - "edited" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, { "type": "string", - "name": "html_url", - "description": "

Points to the HTML wiki page.

", + "name": "body", + "description": "", "isRequired": true }, { - "type": "string", - "name": "page_name", - "description": "

The name of the page.

", + "type": "integer", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "sha", - "description": "

The latest commit SHA of the page.

", + "name": "created_at", + "description": "", "isRequired": true }, { - "type": "string or null", - "name": "summary", + "type": "integer", + "name": "discussion_id", "description": "", "isRequired": true }, { "type": "string", - "name": "title", - "description": "

The current page title.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "default", - "category": "gollum" - } - }, - "installation": { - "created": { - "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "description": "", "isRequired": true }, { @@ -26403,214 +30438,475 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object or null", - "name": "requester", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", + "type": "integer or null", + "name": "parent_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "login", + "type": "object", + "name": "reactions", "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] }, { "type": "string", - "name": "node_id", - "description": "" + "name": "repository_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "organizations_url", - "description": "" + "name": "updated_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "received_events_url", - "description": "" + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "repos_url", - "description": "" + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true }, { - "type": "boolean", - "name": "site_admin", - "description": "" + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { "type": "string", - "name": "type", + "name": "body", "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } ] }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "created", - "category": "installation" - }, - "deleted": { - "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "deleted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + "name": "created_at", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "full_name", + "name": "html_url", "description": "", "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

", + "description": "", "isRequired": true }, { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "type": "boolean", + "name": "locked", + "description": "", "isRequired": true }, { @@ -26620,159 +30916,235 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer", + "name": "number", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "deleted", - "category": "installation" - }, - "new_permissions_accepted": { - "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "new_permissions_accepted" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

Installation

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, { "type": "string", - "name": "full_name", + "name": "repository_url", "description": "", "isRequired": true }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true + "name": "timeline_url", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "title", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "updated_at", + "description": "", "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] } ] }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "app" - ], - "action": "new_permissions_accepted", - "category": "installation" - }, - "suspend": { - "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "suspend" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "enterprise", @@ -26784,8 +31156,7 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", - "isRequired": true, + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", "childParamsGroups": [] }, { @@ -26795,57 +31166,14 @@ "description": "

A GitHub organization.

", "childParamsGroups": [] }, - { - "type": "array of objects", - "name": "repositories", - "in": "body", - "description": "

An array of repository objects that the installation can access.

", - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the repository.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", - "isRequired": true - } - ] - }, { "type": "object", "name": "repository", "in": "body", "description": "

A repository on GitHub.

", + "isRequired": true, "childParamsGroups": [] }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, { "type": "object", "name": "sender", @@ -26856,14 +31184,16 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "suspend", - "category": "installation" + "action": "deleted", + "category": "discussion_comment" }, - "unsuspend": { - "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "edited": { + "descriptionHtml": "

A comment on a discussion was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

", "bodyParameters": [ { "type": "string", @@ -26872,54 +31202,90 @@ "description": "", "isRequired": true, "enum": [ - "unsuspend" + "edited" ], "childParamsGroups": [] }, { "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", + "name": "changes", "in": "body", - "description": "

Installation

", + "description": "", "isRequired": true, - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] }, { "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "array of objects", - "name": "repositories", + "name": "comment", "in": "body", - "description": "

An array of repository objects that the installation can access.

", + "description": "", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "name": "child_comment_count", + "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", "isRequired": true }, { @@ -26929,26 +31295,742 @@ "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "integer or null", + "name": "parent_id", + "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "null", - "name": "requester", - "in": "body", - "description": "" - }, + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, { "type": "object", "name": "sender", @@ -26959,16 +32041,78 @@ } ], "availability": [ + "repository", + "organization", "app" ], - "action": "unsuspend", - "category": "installation" + "action": "edited", + "category": "discussion_comment" } }, - "installation_repositories": { - "added": { - "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "fork": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "forkee", + "in": "body", + "description": "

The created repository resource.

", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "default", + "category": "fork" + } + }, + "github_app_authorization": { + "revoked": { + "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", "bodyParameters": [ { "type": "string", @@ -26977,7 +32121,7 @@ "description": "", "isRequired": true, "enum": [ - "added" + "revoked" ], "childParamsGroups": [] }, @@ -26992,9 +32136,57 @@ "type": "object", "name": "installation", "in": "body", - "description": "

Installation

", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", "isRequired": true, "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "revoked", + "category": "github_app_authorization" + } + }, + "gollum": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] }, { "type": "object", @@ -27005,74 +32197,152 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "pages", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", + "description": "

The pages that were updated.

", "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "full_name", - "description": "", - "isRequired": true + "name": "action", + "description": "

The action that was performed on the page. Can be created or edited.

", + "isRequired": true, + "enum": [ + "created", + "edited" + ] }, { - "type": "integer", - "name": "id", - "description": "

Unique identifier of the repository

", + "type": "string", + "name": "html_url", + "description": "

Points to the HTML wiki page.

", "isRequired": true }, { "type": "string", - "name": "name", - "description": "

The name of the repository.

", + "name": "page_name", + "description": "

The name of the page.

", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "sha", + "description": "

The latest commit SHA of the page.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", "description": "", "isRequired": true }, { - "type": "boolean", - "name": "private", - "description": "

Whether the repository is private or public.

", + "type": "string", + "name": "title", + "description": "

The current page title.

", "isRequired": true } ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "gollum" + } + }, + "installation": { + "created": { + "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", "name": "full_name", - "description": "" + "description": "", + "isRequired": true }, { "type": "integer", "name": "id", - "description": "

Unique identifier of the repository

" + "description": "

Unique identifier of the repository

", + "isRequired": true }, { "type": "string", "name": "name", - "description": "

The name of the repository.

" + "description": "

The name of the repository.

", + "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "", + "isRequired": true }, { "type": "boolean", "name": "private", - "description": "

Whether the repository is private or public.

" + "description": "

Whether the repository is private or public.

", + "isRequired": true } ] }, @@ -27083,23 +32353,11 @@ "description": "

A repository on GitHub.

", "childParamsGroups": [] }, - { - "type": "string", - "name": "repository_selection", - "in": "body", - "description": "

Describe whether all repositories have been selected or there's a selection involved

", - "isRequired": true, - "enum": [ - "all", - "selected" - ] - }, { "type": "object or null", "name": "requester", "in": "body", "description": "", - "isRequired": true, "childParamsGroups": [ { "type": "string", @@ -27227,12 +32485,12 @@ "availability": [ "app" ], - "action": "added", - "category": "installation_repositories" + "action": "created", + "category": "installation" }, - "removed": { - "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "deleted": { + "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -27241,7 +32499,7 @@ "description": "", "isRequired": true, "enum": [ - "removed" + "deleted" ], "childParamsGroups": [] }, @@ -27269,10 +32527,9 @@ }, { "type": "array of objects", - "name": "repositories_added", + "name": "repositories", "in": "body", - "description": "

An array of repository objects, which were added to the installation.

", - "isRequired": true, + "description": "

An array of repository objects that the installation can access.

", "childParamsGroups": [ { "type": "string", @@ -27307,20 +32564,699 @@ ] }, { - "type": "array of objects", - "name": "repositories_removed", + "type": "object", + "name": "repository", "in": "body", - "description": "

An array of repository objects, which were removed from the installation.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "full_name", - "description": "", - "isRequired": true - }, - { - "type": "integer", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "deleted", + "category": "installation" + }, + "new_permissions_accepted": { + "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "new_permissions_accepted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "new_permissions_accepted", + "category": "installation" + }, + "suspend": { + "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "suspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "suspend", + "category": "installation" + }, + "unsuspend": { + "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unsuspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "

An array of repository objects that the installation can access.

", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "unsuspend", + "category": "installation" + } + }, + "installation_repositories": { + "added": { + "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

" + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

" + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "

Describe whether all repositories have been selected or there's a selection involved

", + "isRequired": true, + "enum": [ + "all", + "selected" + ] + }, + { + "type": "object or null", + "name": "requester", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "added", + "category": "installation_repositories" + }, + "removed": { + "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

Installation

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "

An array of repository objects, which were added to the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "

An array of repository objects, which were removed from the installation.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", "name": "id", "description": "

Unique identifier of the repository

", "isRequired": true @@ -59770,166 +65706,3523 @@ }, { "type": "string", - "name": "organizations_url", - "description": "", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "deleted", + "category": "projects_v2_item" + }, + "edited": { + "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object or object", + "name": "changes", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2_item" + }, + "reordered": { + "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reordered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "previous_projects_v2_item_node_id", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "reordered", + "category": "projects_v2_item" + }, + "restored": { + "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "restored" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "archived_at", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "

An item belonging to a project

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

The type of content tracked in a project item

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "restored", + "category": "projects_v2_item" + } + }, + "public": { + "default": { + "descriptionHtml": "", + "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "public" + } + }, + "pull_request": { + "assigned": { + "descriptionHtml": "

A pull request was assigned to a user.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "

The status of auto merging a pull request.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "

Commit message for the merge commit.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "

Title for the merge commit message.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "

The merge method to use.

", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "

Indicates whether or not the pull request is a draft.

", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "

A git repository

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "

Whether to allow auto-merge for pull requests.

", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "

Whether to allow private forks

" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "

Whether to allow merge commits for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "

Whether to allow rebase merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "

Whether to allow squash merges for pull requests.

", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "

Whether the repository is archived.

", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "

The default branch of the repository.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "

Whether to delete head branches when pull requests are merged

", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "

Returns whether or not this repository is disabled.

" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "

Whether downloads are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "

Whether issues are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "

Whether projects are enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "

Whether the wiki is enabled.

", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the repository

", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the repository.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "

Whether the repository is private or public.

", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "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.
    • \n
", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + { + "type": "string", + "name": "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).
    • \n
", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "use_squash_pr_title_as_default", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "

Whether to require contributors to sign off on web-based commits

" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", "isRequired": true }, { - "type": "string", - "name": "repos_url", + "type": "boolean", + "name": "default", "description": "", "isRequired": true }, { - "type": "string", - "name": "events_url", + "type": "string or null", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "received_events_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", + "name": "name", + "description": "

The name of the label.

", "isRequired": true }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "node_id", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_at", - "description": "" + "name": "url", + "description": "

URL for the label

", + "isRequired": true } ] }, { - "type": "string", - "name": "created_at", + "type": "boolean", + "name": "locked", "description": "", "isRequired": true }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "boolean", + "name": "maintainer_can_modify", + "description": "

Indicates whether maintainers can modify the pull request.

" }, { "type": "string or null", - "name": "archived_at", + "name": "merge_commit_sha", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "deleted", - "category": "projects_v2_item" - }, - "edited": { - "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object or object", - "name": "changes", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "number", - "name": "id", - "description": "", - "isRequired": true + "type": "boolean or null", + "name": "mergeable", + "description": "" }, { "type": "string", - "name": "node_id", + "name": "mergeable_state", "description": "" }, { - "type": "string", - "name": "project_node_id", + "type": "boolean or null", + "name": "merged", "description": "" }, { - "type": "string", - "name": "content_node_id", + "type": "string or null", + "name": "merged_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", - "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "object or null", + "name": "merged_by", + "description": "", "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -59939,298 +69232,257 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization" + ] }, { "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2_item" - }, - "reordered": { - "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reordered" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "previous_projects_v2_item_node_id", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", + "name": "url", "description": "" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "project_node_id", - "description": "" - }, - { - "type": "string", - "name": "content_node_id", - "description": "", - "isRequired": true }, { - "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", "isRequired": true, - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", "childParamsGroups": [ { "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", + "name": "closed_at", "description": "", "isRequired": true }, { "type": "integer", - "name": "id", + "name": "closed_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "node_id", + "name": "created_at", "description": "", "isRequired": true }, { - "type": "string", - "name": "avatar_url", + "type": "object or null", + "name": "creator", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "string or null", - "name": "gravatar_id", + "name": "description", "description": "", "isRequired": true }, { - "type": "string", - "name": "url", + "type": "string or null", + "name": "due_on", "description": "", "isRequired": true }, @@ -60241,217 +69493,312 @@ "isRequired": true }, { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", + "name": "labels_url", "description": "", "isRequired": true }, { "type": "string", - "name": "starred_url", + "name": "node_id", "description": "", "isRequired": true }, { - "type": "string", - "name": "subscriptions_url", - "description": "", + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", "isRequired": true }, { - "type": "string", - "name": "organizations_url", + "type": "integer", + "name": "open_issues", "description": "", "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] }, { "type": "string", - "name": "events_url", - "description": "", + "name": "title", + "description": "

The title of the milestone.

", "isRequired": true }, { "type": "string", - "name": "received_events_url", + "name": "updated_at", "description": "", "isRequired": true }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", + "name": "url", "description": "", "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" } ] }, { "type": "string", - "name": "created_at", + "name": "node_id", "description": "", "isRequired": true }, + { + "type": "integer", + "name": "number", + "description": "

Number uniquely identifying the pull request within its repository.

", + "isRequired": true + }, { "type": "string", - "name": "updated_at", + "name": "patch_url", "description": "", "isRequired": true }, { - "type": "string or null", - "name": "archived_at", + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", "description": "", "isRequired": true - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reordered", - "category": "projects_v2_item" - }, - "restored": { - "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

Note: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "restored" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ + }, { - "type": "object", - "name": "archived_at", + "type": "array of objects", + "name": "requested_teams", "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "from", + "type": "boolean", + "name": "deleted", "description": "" }, { "type": "string or null", - "name": "to", + "name": "description", + "description": "

Description of the team

" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "

Description of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "

Unique identifier of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

Name of the team

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "

Permission that the team will have for its repositories

" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", "description": "" + }, + { + "type": "string", + "name": "url", + "description": "

URL for the team

" } ] - } - ] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2_item", - "in": "body", - "description": "

An item belonging to a project

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true }, { "type": "string", - "name": "node_id", - "description": "" + "name": "review_comment_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "project_node_id", + "type": "integer", + "name": "review_comments", "description": "" }, { "type": "string", - "name": "content_node_id", + "name": "review_comments_url", "description": "", "isRequired": true }, { "type": "string", - "name": "content_type", - "description": "

The type of content tracked in a project item

", + "name": "state", + "description": "

State of this Pull Request. Either open or closed.

", "isRequired": true, "enum": [ - "Issue", - "PullRequest", - "DraftIssue" + "open", + "closed" ] }, { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "

The title of the pull request.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "name", + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", "description": "" }, { @@ -60461,181 +69808,106 @@ }, { "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "events_url", + "description": "" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "followers_url", + "description": "" }, { "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true + "name": "following_url", + "description": "" }, { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true + "type": "string", + "name": "gists_url", + "description": "" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "gravatar_id", + "description": "" }, { "type": "string", "name": "html_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "followers_url", + "type": "integer", + "name": "id", "description": "", "isRequired": true }, { "type": "string", - "name": "following_url", + "name": "login", "description": "", "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true + "name": "name", + "description": "" }, { "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true + "name": "node_id", + "description": "" }, { "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true + "name": "organizations_url", + "description": "" }, { "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true + "name": "received_events_url", + "description": "" }, { "type": "string", "name": "repos_url", - "description": "", - "isRequired": true + "description": "" }, { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true + "type": "boolean", + "name": "site_admin", + "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true + "name": "starred_url", + "description": "" }, { "type": "string", - "name": "type", - "description": "", - "isRequired": true + "name": "subscriptions_url", + "description": "" }, { - "type": "boolean", - "name": "site_admin", + "type": "string", + "name": "type", "description": "", - "isRequired": true + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] }, { "type": "string", - "name": "starred_at", + "name": "url", "description": "" } ] - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "archived_at", - "description": "", - "isRequired": true } ] }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "restored", - "category": "projects_v2_item" - } - }, - "public": { - "default": { - "descriptionHtml": "", - "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", - "bodyParameters": [ - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, { "type": "object", "name": "repository", @@ -60658,13 +69930,11 @@ "organization", "app" ], - "action": "default", - "category": "public" - } - }, - "pull_request": { - "assigned": { - "descriptionHtml": "

A pull request was assigned to a user.

", + "action": "assigned", + "category": "pull_request" + }, + "auto_merge_disabled": { + "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -60674,131 +69944,10 @@ "description": "", "isRequired": true, "enum": [ - "assigned" + "auto_merge_disabled" ], "childParamsGroups": [] }, - { - "type": "object or null", - "name": "assignee", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, { "type": "object", "name": "enterprise", @@ -60817,7 +69966,7 @@ "type": "integer", "name": "number", "in": "body", - "description": "

The pull request number.

", + "description": "", "isRequired": true }, { @@ -61082,8 +70231,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -61512,6 +70660,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "boolean", "name": "has_pages", @@ -61532,13 +70687,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "string or null", "name": "homepage", @@ -62255,7 +71403,7 @@ "isRequired": true, "childParamsGroups": [ { - "type": "string or null", + "type": "string", "name": "label", "description": "", "isRequired": true @@ -62267,7 +71415,7 @@ "isRequired": true }, { - "type": "object or null", + "type": "object", "name": "repo", "description": "

A git repository

", "isRequired": true, @@ -63527,8 +72675,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -63972,6 +73119,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -63994,11 +73148,11 @@ "organization", "app" ], - "action": "assigned", + "action": "auto_merge_disabled", "category": "pull_request" }, - "auto_merge_disabled": { - "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "auto_merge_enabled": { + "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -64008,7 +73162,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_disabled" + "auto_merge_enabled" ], "childParamsGroups": [] }, @@ -64724,13 +73878,6 @@ "isRequired": true, "default": true }, - { - "type": "boolean", - "name": "has_discussions", - "description": "

Whether discussions are enabled.

", - "isRequired": true, - "default": false - }, { "type": "boolean", "name": "has_pages", @@ -64751,6 +73898,13 @@ "isRequired": true, "default": true }, + { + "type": "boolean", + "name": "has_discussions", + "description": "

Whether discussions are enabled.

", + "isRequired": true, + "default": false + }, { "type": "string or null", "name": "homepage", @@ -66739,7 +75893,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -67187,6 +76342,80 @@ "type": "string", "name": "reason", "in": "body", + "description": "" + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "auto_merge_enabled", + "category": "pull_request" + }, + "closed": { + "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, @@ -67212,11 +76441,11 @@ "organization", "app" ], - "action": "auto_merge_disabled", + "action": "closed", "category": "pull_request" }, - "auto_merge_enabled": { - "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "converted_to_draft": { + "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { @@ -67226,7 +76455,7 @@ "description": "", "isRequired": true, "enum": [ - "auto_merge_enabled" + "converted_to_draft" ], "childParamsGroups": [] }, @@ -67248,9 +76477,311 @@ "type": "integer", "name": "number", "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", "description": "", "isRequired": true }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "converted_to_draft", + "category": "pull_request" + }, + "demilestoned": { + "descriptionHtml": "

A pull request was removed from a milestone.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "demilestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "

A collection of related issues and pull requests.

", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "

The pull request number.

", + "isRequired": true + }, { "type": "object", "name": "organization", @@ -67513,7 +77044,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -68455,7 +77987,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69437,7 +78969,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", + "description": "

Whether a squash merge commit can use the pull request title as default.

", "default": false }, { @@ -69813,7 +79345,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -70399,725 +79932,340 @@ "description": "" } ] - } - ] - }, - { - "type": "string", - "name": "reason", - "in": "body", - "description": "" - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "auto_merge_enabled", - "category": "pull_request" - }, - "closed": { - "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "closed", - "category": "pull_request" - }, - "converted_to_draft": { - "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "converted_to_draft" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", - "childParamsGroups": [] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

A repository on GitHub.

", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "converted_to_draft", - "category": "pull_request" - }, - "demilestoned": { - "descriptionHtml": "

A pull request was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "demilestoned" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "milestone", - "in": "body", - "description": "

A collection of related issues and pull requests.

", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "labels_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "

The number of the milestone.

", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "

The state of the milestone.

", - "isRequired": true, - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - { - "type": "string", - "name": "title", - "description": "

The title of the milestone.

", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "creator", - "description": "

A GitHub user.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "integer", - "name": "open_issues", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "closed_issues", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "due_on", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "integer", - "name": "number", - "in": "body", - "description": "

The pull request number.

", - "isRequired": true - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "pull_request", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "commits", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "issue", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comment", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "review_comments", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "statuses", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - { - "type": "integer", - "name": "additions", - "description": "" - }, - { - "type": "object or null", - "name": "assignee", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

A repository on GitHub.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "demilestoned", + "category": "pull_request" + }, + "dequeued": { + "descriptionHtml": "

A pull request was removed from the merge queue.

\n

Note: The pull request merge queue feature is currently in limited public beta and subject to change.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

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.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "dequeued" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.

", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] }, { "type": "array of object,nulls", @@ -72051,7 +81199,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73033,7 +82181,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "

Whether a squash merge commit can use the pull request title as default.

", + "description": "

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

", "default": false }, { @@ -73409,8 +82557,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -73999,6 +83146,13 @@ } ] }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, { "type": "object", "name": "repository", @@ -74012,6 +83166,7 @@ "name": "sender", "in": "body", "description": "

A GitHub user.

", + "isRequired": true, "childParamsGroups": [] } ], @@ -74020,7 +83175,7 @@ "organization", "app" ], - "action": "demilestoned", + "action": "dequeued", "category": "pull_request" }, "edited": { @@ -140222,9 +149377,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -140492,9 +149647,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141179,9 +150334,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", @@ -141450,9 +150605,9 @@ "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { - "type": "string", + "type": "null", "name": "updated_at", - "description": "

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "" }, { "type": "string", diff --git a/tests/rendering/breadcrumbs.js b/tests/rendering/breadcrumbs.js index aeb9e46987bf..330d92bbd8c4 100644 --- a/tests/rendering/breadcrumbs.js +++ b/tests/rendering/breadcrumbs.js @@ -93,17 +93,15 @@ describe('breadcrumbs', () => { test('early access article pages have breadcrumbs with product, category, and article', async () => { const $ = await getDOM( - '/early-access/github/enforcing-best-practices-with-github-policies/about-github-policies' + '/early-access/enterprise-importer/understanding-github-enterprise-importer' ) const $breadcrumbTitles = $('[data-testid=breadcrumbs] [data-testid=breadcrumb-title]') const $breadcrumbLinks = $('[data-testid=breadcrumbs] a') expect($breadcrumbTitles).toHaveLength(0) expect($breadcrumbLinks).toHaveLength(4) - expect($breadcrumbLinks[0].attribs.title).toBe( - 'Enforcing best practices with GitHub Policies' - ) - expect($breadcrumbLinks[1].attribs.title).toBe('About GitHub Policies') + expect($breadcrumbLinks[0].attribs.title).toBe('GitHub Enterprise Importer') + expect($breadcrumbLinks[1].attribs.title).toBe('Understand the Importer') expect($breadcrumbLinks[1].attribs.class.includes('color-fg-muted')).toBe(true) }) }) diff --git a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md index 7186ebf26592..2adee6a3f4e1 100644 --- a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md +++ b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md @@ -180,24 +180,35 @@ jobs: ``` {% endraw %} +## Calling a reusable workflow + +You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. + +[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) + +You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} + +{% data reusables.actions.reusable-workflow-calling-syntax %} + +You can call multiple workflows, referencing each in a separate job. + +{% data reusables.actions.uses-keyword-example %} + +### Passing inputs and secrets to a reusable workflow + +{% data reusables.actions.pass-inputs-to-reusable-workflows%} + {% ifversion actions-reusable-workflow-matrix %} -## Using a matrix strategy with a reusable workflow +### Using a matrix strategy with a reusable workflow Jobs using the matrix strategy can call a reusable workflow. A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. For example, you can use a matrix strategy to pass different inputs to a reusable workflow. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)." -### Example matrix strategy with a reusable workflow - -This workflow file references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. The workflow will run three jobs, one for each value in the variable. The workflow file also calls a reusable workflow by using the `uses` keyword. +This example job below calls a reusable workflow and references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. It will run three jobs, one for each value in the variable. {% raw %} ```yaml{:copy} -name: Reusable workflow with matrix strategy - -on: - push: - jobs: ReuseableMatrixJobForDeployment: strategy: @@ -208,25 +219,7 @@ jobs: target: ${{ matrix.target }} ``` {% endraw %} - {% endif %} -## Calling a reusable workflow - -You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. - -[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) - -You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} - -{% data reusables.actions.reusable-workflow-calling-syntax %} - -You can call multiple workflows, referencing each in a separate job. - -{% data reusables.actions.uses-keyword-example %} - -### Passing inputs and secrets to a reusable workflow - -{% data reusables.actions.pass-inputs-to-reusable-workflows%} ### Supported keywords for jobs that call a reusable workflow @@ -238,7 +231,12 @@ When you call a reusable workflow, you can only use the following keywords in th * [`jobs..with.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id) * [`jobs..secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets) * [`jobs..secrets.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id) - {% ifversion actions-inherit-secrets-reusable-workflows %}* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %} +{%- ifversion actions-inherit-secrets-reusable-workflows %} +* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit) +{%- endif %} +{%- ifversion actions-reusable-workflow-matrix %} +* [`jobs..strategy`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategy) +{%- endif %} * [`jobs..needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds) * [`jobs..if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) * [`jobs..permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions) diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index 5b582d063045..e4f70c36cb33 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -33,15 +33,13 @@ During initialization, the enterprise owner will name your enterprise, configure To begin initialization, you will receive an invitation email from {% data variables.product.company_short %}. Before you configure {% data variables.product.prodname_ghe_managed %}, review the following prerequisites. -1. To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." +To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." - {% note %} - - **Note**: {% data reusables.saml.create-a-machine-user %} +{% note %} - {% endnote %} +**Note**: {% data reusables.saml.create-a-machine-user %} -2. {% data reusables.saml.assert-the-administrator-attribute %} +{% endnote %} ## Signing in and naming your enterprise @@ -66,6 +64,7 @@ To configure authentication for {% data variables.product.product_name %}, you m !["Test SAML configuration" button](/assets/images/enterprise/configuration/ae-test-saml-configuration.png) 1. Click **Save**. !["Save" button for IdP configuration](/assets/images/enterprise/configuration/ae-save.png) +1. {% data reusables.saml.assert-the-administrator-attribute %} ## Setting your enterprise policies diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md index 81c9ece1310b..a5d9b95ac660 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md @@ -11,12 +11,12 @@ type: overview topics: - Clustering - Enterprise -ms.openlocfilehash: c0f442f455bffea9fd6e7bd225d7c37c0820b4ab -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d +ms.openlocfilehash: 6c009e5d5aa1c2f0b2d3effb3beab2d51f48b070 +ms.sourcegitcommit: ced661bdffebd0f96f6f76db109fbe31983448ba ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145112785' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148167082' --- {% data reusables.enterprise_clustering.clustering-requires-https %} @@ -56,7 +56,7 @@ La agrupación permite que los servicios que constituyen {% data variables.produ - Establecer niveles de nodos que tengan sentido para tu organización. Un ejemplo de configuración: - Nivel de cara al usuario con dos nodos y los siguientes servicios: - `web-server` - - `jobs-server` + - `job-server` - `memcache-server` - Nivel de base de datos con tres nodos y los siguientes servicios: - `consul-server` diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md index 0f489567d954..d9f9b98dbcbf 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md @@ -1,6 +1,6 @@ --- -title: Inicializar la agrupación -intro: 'Una agrupación de {% data variables.product.prodname_ghe_server %} se debe configurar con una licencia y se debe inicializar mediante un shell administrativo (SSH).' +title: Initializing the cluster +intro: 'A {% data variables.product.prodname_ghe_server %} cluster must be set up with a license and initialized using the administrative shell (SSH).' redirect_from: - /enterprise/admin/clustering/initializing-the-cluster - /enterprise/admin/enterprise-management/initializing-the-cluster @@ -11,111 +11,151 @@ type: how_to topics: - Clustering - Enterprise -ms.openlocfilehash: ea771194e8bf5104707a645c4ee18473ff235153 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146331820' --- {% data reusables.enterprise_clustering.clustering-requires-https %} -## Instalar {% data variables.product.prodname_ghe_server %} +## Installing {% data variables.product.prodname_ghe_server %} -1. En cada nodo de agrupación, suministra e instala {% data variables.product.prodname_ghe_server %}. Para obtener más información, consulta "[Configuración de una instancia de {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)". -2. Mediante el shell administrativo o DHCP, configura **solo** la dirección IP de cada nodo. No configures los otros parámetros. +1. On each cluster node, provision and install {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." +2. Using the administrative shell or DHCP, **only** configure the IP address of each node. Don't configure any other settings. -## Configurar el primer nodo +## Configuring the first node -1. Conéctate al nodo que se designará como principal de MySQL en `cluster.conf`. Para obtener más información, consulta "[Acerca del archivo de configuración del clúster](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -2. En el explorador web, ve a `https://:8443/setup/`. -{% data reusables.enterprise_installation.upload-a-license-file %} {% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} {% data reusables.enterprise_installation.instance-will-restart-automatically %} +1. Connect to the node that will be designated as MySQL primary in `cluster.conf`. For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)." +2. In your web browser, visit `https://:8443/setup/`. +{% data reusables.enterprise_installation.upload-a-license-file %} +{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} +{% data reusables.enterprise_installation.instance-will-restart-automatically %} -## Inicializar la agrupación +## Initializing the cluster -Para inicializar el clúster, necesitas un archivo de configuración del clúster (`cluster.conf`). Para obtener más información, consulta "[Acerca del archivo de configuración del clúster](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". +To initialize the cluster, you need a cluster configuration file (`cluster.conf`). For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -1. Desde el primer nodo que se configuró, ejecuta `ghe-cluster-config-init`. De esta manera, se inicializará la agrupación si existen nodos en el archivo de configuración de la agrupación que no están configurados. -2. Ejecute `ghe-cluster-config-apply`. De esta manera se validará el archivo `cluster.conf`, se aplicará la configuración a cada archivo del nodo y se traerán los servicios configurados en cada nodo. +1. From the first node that was configured, run `ghe-cluster-config-init`. This will initialize the cluster if there are nodes in the cluster configuration file that are not configured. +2. Run `ghe-cluster-config-apply`. This will validate the `cluster.conf` file, apply the configuration to each node file and bring up the configured services on each node. -Para comprobar el estado de un clúster en ejecución, usa el comando `ghe-cluster-status`. +To check the status of a running cluster use the `ghe-cluster-status` command. -## Acerca del archivo de configuración de la agrupación +## About the cluster configuration file -El archivo de configuración del clúster (`cluster.conf`) define los nodos del clúster y qué servicios ejecutan. -Para obtener más información, consulta "[Acerca de los nodos de clúster](/enterprise/admin/guides/clustering/about-cluster-nodes)". +The cluster configuration file (`cluster.conf`) defines the nodes in the cluster, and what services they run. +For more information, see "[About cluster nodes](/enterprise/admin/guides/clustering/about-cluster-nodes)." -En este ejemplo, `cluster.conf` define un clúster con cinco nodos. +This example `cluster.conf` defines a cluster with 11 nodes. - - Dos nodos (denominados `ghe-app-node-\*`) ejecutan los servicios `web-server` y `job-server` responsables de responder a las solicitudes de cliente. - - Tres nodos (denominados `ghe-data-node-\*`) ejecutan los servicios responsables del almacenamiento y la recuperación de los datos de {% data variables.product.prodname_ghe_server %}. + - Two nodes called `ghes-front-end-node-\*` run services responsible for responding to client requests. + - Three nodes called `ghes-database-node-\*` run services responsible for storage, retrieval, and replication of database data. + - Three nodes called `ghes-search-node-\*` run services responsible for search functionality. + - Three nodes called `ghes-storage-node-\*` run services responsible for storage, retrieval, and replication of data. -Los nombres de los nodos pueden ser cualquier nombre de host válido que elijas. Los nombres se establecen como el nombre de host de cada nodo y también se agregarán a `/etc/hosts` en cada nodo, de manera que los nodos puedan ser resolubles localmente entre sí. +The names of the nodes can be any valid hostname you choose. The names are set as the hostname of each node, and will also be added to `/etc/hosts` on each node, so that the nodes are locally resolvable to each other. -Especifica el primer nodo de clúster que configuraste como principal de MySQL mediante `mysql-server` y `mysql-master`. +Specify the first cluster node you configured as the MySQL primary via `mysql-server` and `mysql-master`. ```ini [cluster] - mysql-master = ghe-data-node-1 - redis-master = ghe-data-node-1 - primary-datacenter = default -[cluster "ghe-app-node-1"] - hostname = ghe-app-node-1 + mysql-master = ghes-database-node-1 + redis-master = ghes-database-node-1 + primary-datacenter = primary +[cluster "ghes-front-end-node-1"] + hostname = ghes-front-end-node-1 ipv4 = 192.168.0.2 # ipv6 = fd12:3456:789a:1::2 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-app-node-2"] - hostname = ghe-app-node-2 + memcache-server = true +[cluster "ghes-front-end-node-2"] + hostname = ghes-front-end-node-2 ipv4 = 192.168.0.3 # ipv6 = fd12:3456:789a:1::3 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-data-node-1"] - hostname = ghe-data-node-1 + memcache-server = true +[cluster "ghes-database-node-1"] + hostname = ghes-database-node-1 ipv4 = 192.168.0.4 # ipv6 = fd12:3456:789a:1::4 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-2"] - hostname = ghe-data-node-2 +[cluster "ghes-database-node-2"] + hostname = ghes-database-node-2 ipv4 = 192.168.0.5 # ipv6 = fd12:3456:789a:1::5 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-3"] - hostname = ghe-data-node-3 +[cluster "ghes-database-node-3"] + hostname = ghes-database-node-3 ipv4 = 192.168.0.6 # ipv6 = fd12:3456:789a:1::6 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true +[cluster "ghes-search-node-1"] + hostname = ghes-search-node-1 + ipv4 = 192.168.0.7 + # ipv6 = fd12:3456:789a:1::7 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-2"] + hostname = ghes-search-node-2 + ipv4 = 192.168.0.8 + # ipv6 = fd12:3456:789a:1::8 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-3"] + hostname = ghes-search-node-3 + ipv4 = 192.168.0.9 + # ipv6 = fd12:3456:789a:1::9 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-storage-node-1"] + hostname = ghes-storage-node-1 + ipv4 = 192.168.0.10 + # ipv6 = fd12:3456:789a:1::10 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true metrics-server = true +[cluster "ghes-storage-node-2"] + hostname = ghes-storage-node-2 + ipv4 = 192.168.0.11 + # ipv6 = fd12:3456:789a:1::11 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true storage-server = true + metrics-server = true +[cluster "ghes-storage-node-3"] + hostname = ghes-storage-node-3 + ipv4 = 192.168.0.12 + # ipv6 = fd12:3456:789a:1::12 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true + metrics-server = true ``` -Crea el archivo `/data/user/common/cluster.conf` en el primer nodo configurado. Por ejemplo, al usar `vim`: +Create the file `/data/user/common/cluster.conf` on the configured first node. For example, using `vim`: ```shell ghe-data-node-1:~$ sudo vim /data/user/common/cluster.conf diff --git a/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md deleted file mode 100644 index 0da110764894..000000000000 --- a/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Habilitar las GitHub Actions con la puerta de enlace de MinIO para el almacenamiento en NAS -intro: 'Puedes habilitar {% data variables.product.prodname_actions %} en {% data variables.product.prodname_ghe_server %} y utilizar la puerta de enlace de MinIO para el almacenamiento en NAS a fin de almacenar datos que generan las ejecuciones del flujo de trabajo.' -permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' -versions: - ghes: '*' -type: how_to -topics: - - Actions - - Enterprise - - Infrastructure - - Storage -redirect_from: - - /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage -shortTitle: MinIO Gateway for NAS storage -ms.openlocfilehash: bb738d04d54234704f3278422c1f1ef075956640 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148106873' ---- -{% data reusables.actions.minio-gateways-removal %} - -## Prerrequisitos - -Antes de que habilites las {% data variables.product.prodname_actions %}, asegúrate de que has completado los siguientes pasos: - -* Para evitar la contención de recursos en el dispositivo, te recomendamos que hospedes MinIO separado de {% data variables.location.product_location %}. -* Crea un cubo para almacenar los datos del flujo de trabajo. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} - -{% data reusables.actions.enterprise-common-prereqs %} - -## Habilitar las {% data variables.product.prodname_actions %} con la puerta de enlace de MinIO para almacenamiento en NAS - -{% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. En "Artifact & Log Storage" (Almacenamiento de artefactos y registros), seleccione **Amazon S3** y escriba los detalles del cubo de almacenamiento: - - * **AWS Service URL** (URL del servicio AWS): dirección URL del servicio MinIO. Por ejemplo, `https://my-minio.example:9000`. - * **AWS S3 Bucket** (Cubo de AWS S3): nombre del cubo de S3. - * **AWS S3 Access Key** (Clave de acceso de AWS S3) y **AWS S3 Secret Key** (Clave de secreto de AWS S3): se usan `MINIO_ACCESS_KEY` y `MINIO_SECRET_KEY` para la instancia de MinIO. - - ![Botón radial para seleccionar el almacenamiento de Amazon S3 y los campos para la configuración de MinIO](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) -1. En "Artifact & Log Storage" (Almacenamiento de artefactos y registros), seleccione **Force path style** (Forzar estilo de ruta de acceso). - - ![Casilla Forzar estilo de ruta de acceso](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} - -{% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md b/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md index 1b91094d5c94..16d16896a160 100644 --- a/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md +++ b/translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md @@ -9,14 +9,14 @@ children: - /enabling-github-actions-with-azure-blob-storage - /enabling-github-actions-with-amazon-s3-storage - /enabling-github-actions-with-google-cloud-storage - - /enabling-github-actions-with-minio-gateway-for-nas-storage + - /enabling-github-actions-with-minio-storage - /managing-self-hosted-runners-for-dependabot-updates shortTitle: Enable GitHub Actions -ms.openlocfilehash: 273e03407dd8c3c0a125e2c215a973c88aaf884b -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 56512f06952512bec06068273f8df381a7ba4706 +ms.sourcegitcommit: 8f1801040a84ca9353899a2d1e6782c702aaed0d ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148109900' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148166549' --- diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index b4868411b1ce..6d81bf03fffc 100644 --- a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -131,7 +131,7 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {%- ifversion actions-ghes-gcp-storage %} * Google Cloud Storage {%- endif %} -* S3-compatible MinIO Gateway for NAS +* S3-compatible MinIO cluster {% note %} @@ -141,8 +141,6 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {% endnote %} -{% data reusables.actions.minio-gateways-removal %} - ## Networking considerations {% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." @@ -158,7 +156,7 @@ Follow one of the procedures below to enable {% data variables.product.prodname_ {%- ifversion actions-ghes-gcp-storage %} * [Enabling GitHub Actions with Google Cloud Storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage) {%- endif %} -* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage) +* [Enabling GitHub Actions with MinIO storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage) ## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 092db2245c14..ceebd276ec9b 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -1,7 +1,7 @@ --- -title: Configurar la autenticación y el aprovisionamiento para tu empresa utilizando Azure AD +title: Configuring authentication and provisioning for your enterprise using Azure AD shortTitle: Configure with Azure AD -intro: "Puedes usar un inquilino en Azure Active Directory (Azure\_AD) como proveedor de identidades (IdP) para administrar centralmente la autenticación y el aprovisionamiento de usuarios para {% data variables.location.product_location %}." +intro: 'You can use a tenant in Azure Active Directory (Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.location.product_location %}.' permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.' versions: ghae: '*' @@ -17,67 +17,65 @@ redirect_from: - /admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad -ms.openlocfilehash: 10b6fdaa2014836e7a709bc94920dea6331ed030 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148107519' --- -## Acerca de la autenticación y el aprovisionamiento de usuarios con Azure AD -Azure Active Directory (Azure AD) es un servicio de Microsoft que te permite administrar centralmente las cuentas de usuario y el acceso a las aplicaciones web. Para obtener más información, consulte [¿Qué Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) en Microsoft Docs. +## About authentication and user provisioning with Azure AD -Para administrar la identidad y el acceso para {% data variables.product.product_name %}, puedes utilizar un inquilino en Azure AD como un IdP de SAML para la autenticación. También puedes configurar Azure AD de modo que aprovisione automáticamente las cuentas y acceda a las pertenencias con SCIM, lo cual te permite crear usuarios de {% data variables.product.product_name %} y administrar las pertenencias de equipo y de organización desde tu inquilino de Azure AD. +Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs. + +To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access membership with SCIM, which allows you to create {% data variables.product.product_name %} users and manage team and organization membership from your Azure AD tenant. {% data reusables.scim.ghes-beta-note %} -Después de habilitar el inicio de sesión único de SAML y SCIM para {% data variables.product.product_name %} mediante Azure AD, puedes hacer lo siguiente desde tu inquilino de Azure AD. +After you enable SAML SSO and SCIM for {% data variables.product.product_name %} using Azure AD, you can accomplish the following from your Azure AD tenant. -* Asignar la aplicación de {% data variables.product.product_name %} en Azure AD a una cuenta de usuario para que cree y otorgue acceso automáticamente a una cuenta de usuario correspondiente en {% data variables.product.product_name %}. -* Desasignar la aplicación de {% data variables.product.product_name %} de una cuenta de usuario en Azure AD para desactivar la cuenta de usuario correspondiente en {% data variables.product.product_name %}. -* Asignar la aplicación de {% data variables.product.product_name %} a un grupo de IdP en Azure AD para que cree y otorgue acceso automáticamente a las cuentas de usuario en {% data variables.product.product_name %} para todos los miembros del grupo de IdP. Además, el grupo de IdP estará disponible en {% data variables.product.product_name %} para que se conecte a un equipo y a sus organizaciones primarias. -* Desasignar la aplicación de {% data variables.product.product_name %} desde un grupo de IdP para desactivar las cuentas de usuario de {% data variables.product.product_name %} de todos los usuarios de IdP que tuvieron acceso únicamente a través de este grupo de IdP y eliminar a los usuarios de la organización primaria. El grupo de IdP se desconectará de cualquier equipo en {% data variables.product.product_name %}. +* Assign the {% data variables.product.product_name %} application on Azure AD to a user account to automatically create and grant access to a corresponding user account on {% data variables.product.product_name %}. +* Unassign the {% data variables.product.product_name %} application to a user account on Azure AD to deactivate the corresponding user account on {% data variables.product.product_name %}. +* Assign the {% data variables.product.product_name %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.product_name %} for connection to a team and its parent organization. +* Unassign the {% data variables.product.product_name %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. -Para obtener más información sobre cómo administrar la identidad y el acceso de la empresa en{% data variables.location.product_location %}, consulta "[Administración de la identidad y el acceso para la empresa](/admin/authentication/managing-identity-and-access-for-your-enterprise)". Para obtener más información sobre la sincronización de equipos con grupos de IdP, consulte "[Sincronizar un equipo con un grupo de proveedores de identidades](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)". +For more information about managing identity and access for your enterprise on {% data variables.location.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." -## Requisitos previos +## Prerequisites -- Para configurar la autenticación y el aprovisionamiento de usuarios para {% data variables.product.product_name %} utilizando Azure AD, debes tener una cuenta y un inquilino en Azure AD. Para obtener más información, consulte el [sitio web de Azure AD](https://azure.microsoft.com/free/active-directory) e [Inicio rápido: Creación de un inquilino de Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) en Microsoft Docs. +- To configure authentication and user provisioning for {% data variables.product.product_name %} using Azure AD, you must have an Azure AD account and tenant. For more information, see the [Azure AD website](https://azure.microsoft.com/free/active-directory) and [Quickstart: Create an Azure Active Directory tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) in the Microsoft Docs. {%- ifversion scim-for-ghes %} -- {% data reusables.saml.ghes-you-must-configure-saml-sso %} {%- endif %} - -- {% data reusables.saml.assert-the-administrator-attribute %} Para obtener más información sobre la inclusión del atributo `administrator` en la notificación de SAML de Azure AD, consulte [Procedimiento: Personalización de las notificaciones emitidas en el token SAML para aplicaciones empresariales](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) en Microsoft Docs. +- {% data reusables.saml.ghes-you-must-configure-saml-sso %} +{%- endif %} - {% data reusables.saml.create-a-machine-user %} -## Configurar la autenticación y el aprovisionamiento de usuarios con Azure AD +## Configuring authentication and user provisioning with Azure AD -En el inquilino de Azure AD, agrega la aplicación para {% data variables.product.product_name %} y, luego, configura el aprovisionamiento. +In your Azure AD tenant, add the application for {% data variables.product.product_name %}, then configure provisioning. {% ifversion ghae %} -1. En Azure AD, agrega la {% data variables.enterprise.ae_azure_ad_app_link %} a tu inquilino y configura el inicio de sesión único. Para obtener más información, consulta [Tutorial: Integración del inicio de sesión único (SSO) de Azure Active Directory con {% data variables.product.product_name %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) en Microsoft Docs. +1. In Azure AD, add the {% data variables.enterprise.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.product_name %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs. -1. En {% data variables.product.product_name %}, especifica los detalles de tu inquilino de Azure AD. +1. In {% data variables.product.product_name %}, enter the details for your Azure AD tenant. - {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} - - Si ya configuraste el SSO de SAML para {% data variables.location.product_location %} con otro IdP y quieres usar Azure AD en su lugar, puedes editar la configuración. Para obtener más información, consulte "[Configuración del inicio de sesión único de SAML para la empresa](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)". + - If you've already configured SAML SSO for {% data variables.location.product_location %} using another IdP and you want to use Azure AD instead, you can edit your configuration. For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)." -1. Habilita el aprovisionamiento de usuarios en {% data variables.product.product_name %} y configura el aprovisionamiento de usurios en Azure AD. Para obtener más información, consulte "[Configuración del aprovisionamiento de usuarios para la empresa](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)". +1. Enable user provisioning in {% data variables.product.product_name %} and configure user provisioning in Azure AD. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." {% elsif scim-for-ghes %} -1. En el inquilino de Azure AD, en la barra lateral izquierda, haz clic en **Aprovisionamiento**. +1. In the Azure AD tenant, in the left sidebar, click **Provisioning**. -1. En "URL de inquilino", escribe la dirección URL completa del punto de conexión para SCIM en {% data variables.location.product_location %}. Para obtener más información, consulta "[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)" en la documentación de la API REST. +1. Under "Tenant URL", type the full endpoint URL for SCIM on {% data variables.location.product_location %}. For more information, see "[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)" in the REST API documentation. -1. En "Token secreto", escribe el {% data variables.product.pat_v1 %} que creaste en el paso 4 de "[Configuración del aprovisionamiento de usuarios con SCIM para la empresa](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)". +1. Under "Secret Token", type the {% data variables.product.pat_v1 %} that you created in step 4 of "[Configuring user provisioning with SCIM for your enterprise](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." -1. Para garantizar una conexión correcta desde Azure AD con {% data variables.location.product_location %}, haz clic en **Probar conexión**. +1. To ensure a successful connection from Azure AD to {% data variables.location.product_location %}, Click **Test Connection**. -1. Después de asegurarte de que la conexión es correcta, en la parte superior de la página, haz clic en **Guardar**. +1. After you ensure a successful connection, at the top of the page, click **Save**. {% endif %} + +1. Assign an enterprise owner for {% data variables.product.product_name %} in Azure AD. The process you should follow depends on whether you configured provisioning. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." + - If you configured provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, assign the enterprise owner role to the user in Azure AD. + - If you did not configure provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs. diff --git a/translations/es-ES/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/translations/es-ES/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index 443b6038e140..935cf07d9036 100644 --- a/translations/es-ES/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/translations/es-ES/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -24,19 +24,10 @@ This quickstart shows you how to set up MinIO using Docker for use with {% data | MinIO mode | Optimized for | Storage infrastructure required | |----|----|----| | Standalone MinIO (on a single host) | Fast setup | N/A | -| MinIO as a NAS gateway | NAS (Network-attached storage)| NAS devices | | Clustered MinIO (also called Distributed MinIO)| Data security | Storage servers running in a cluster | For more information about your options, see the official [MinIO docs](https://docs.min.io/). -{% warning %} - -**Warning**: MinIO has announced removal of MinIO Gateways. Starting June 1st, 2022, support and bug fixes for the current MinIO NAS Gateway implementation will only be available for paid customers via their LTS support contract. If you want to continue using MinIO Gateways with {% data variables.product.prodname_registry %}, we recommend moving to MinIO LTS support. For more information, see [Scheduled removal of MinIO Gateway for GCS, Azure, HDFS](https://github.com/minio/minio/issues/14331) in the minio/minio repository. - -Other modes of MinIO remain available with standard support. - -{% endwarning %} - ## 2. Install, run, and sign in to MinIO 1. Set up your preferred environment variables for MinIO. @@ -93,18 +84,6 @@ Other modes of MinIO remain available with standard support. For more information, see "[MinIO Docker Quickstart guide](https://docs.min.io/docs/minio-docker-quickstart-guide.html)." - * Run MinIO using Docker as a NAS gateway: - - This setup is useful for deployments where there is already a NAS you want to use as the backup storage for {% data variables.product.prodname_registry %}. - - ```shell - $ docker run -p 9000:9000 \ - -v $MINIO_DIR:/data \ - -e "MINIO_ACCESS_KEY=$MINIO_ACCESS_KEY" \ - -e "MINIO_SECRET_KEY=$MINIO_SECRET_KEY" \ - minio/minio gateway nas /data - ``` - * Run MinIO using Docker as a cluster. This MinIO deployment uses several hosts and MinIO's erasure coding for the strongest data protection. To run MinIO in a cluster mode, see the "[Distributed MinIO Quickstart Guide](https://docs.min.io/docs/distributed-minio-quickstart-guide.html)." ## 3. Create your MinIO bucket for {% data variables.product.prodname_registry %} @@ -124,7 +103,7 @@ Other modes of MinIO remain available with standard support. $ docker run minio/mc BUCKET-NAME ``` - This example can be used for MinIO standalone or MinIO as a NAS gateway. + This example can be used for MinIO standalone. * Clustered deployments example: diff --git a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md index 362bb90ea3bd..cf62edb6c3eb 100644 --- a/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md +++ b/translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md @@ -1,6 +1,6 @@ --- -title: Ver y administrar tus sesiones de SAML activas -intro: Puedes ver y revocar tus sesiones de SAML activas en tus parámetros de seguridad. +title: Viewing and managing your active SAML sessions +intro: You can view and revoke your active SAML sessions in your settings. redirect_from: - /articles/viewing-and-managing-your-active-saml-sessions - /github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions @@ -9,28 +9,31 @@ versions: ghec: '*' topics: - SSO +type: how_to shortTitle: Active SAML sessions -ms.openlocfilehash: ee30f76143ec28a810cd23150d115a3b1cd213c8 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145120033' --- -{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security %} -3. Debajo de "Sesiones" puedes ver tus sesiones activas de SAML. - ![Lista de sesiones de SAML activas](/assets/images/help/settings/saml-active-sessions.png) -4. Para ver los detalles de la sesión, haga clic en **See more** (Ver más). - ![Botón para ver los detalles de una sesión de SAML](/assets/images/help/settings/saml-expand-session-details.png) -5. Para revocar una sesión, haga clic en **Revoke SAML** (Revocar SAML). - ![Botón para revocar una sesión de SAML](/assets/images/help/settings/saml-revoke-session.png) + +You can view a list of devices that have logged into your account, and revoke any SAML sessions that you don't recognize. + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.sessions %} +1. Under "Web sessions," you can see your active SAML sessions. + + ![Screenshot of the list of active SAML sessions](/assets/images/help/settings/saml-active-sessions.png) + +1. To see the session details, click **See more**. + ![Screenshot of the active SAML sessions with the button to open SAML session details emphasized](/assets/images/help/settings/saml-expand-session-details.png) + +1. To revoke a session, click **Revoke SAML**. + + ![Screenshot of the Session details page with the button to revoke a SAML session emphasized](/assets/images/help/settings/saml-revoke-session.png) {% note %} - **Nota:** Cuando revoca una sesión, quita su autenticación de SAML para esa organización. Para volver a acceder a la organización, tendrás que hacer un inicio de sesión único a través de tu proveedor de identidad. Para más información, vea "[Acerca de la autenticación con el inicio de sesión único de SAML](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)". + **Note:** When you revoke a session, you remove your SAML authentication to that organization. To access the organization again, you will need to single sign-on through your identity provider. For more information, see "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)." {% endnote %} -## Información adicional +## Further reading -- "[Acerca de la autenticación con el inicio de sesión único de SAML](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" +- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" diff --git a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/index.md b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/index.md index 3e202cd3272d..b2431aab3349 100644 --- a/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/index.md +++ b/translations/es-ES/content/authentication/keeping-your-account-and-data-secure/index.md @@ -32,6 +32,7 @@ children: - /githubs-ssh-key-fingerprints - /sudo-mode - /preventing-unauthorized-access + - /viewing-and-managing-your-sessions shortTitle: Account security --- diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index 12e391f7d357..cc80b4e51eea 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -1,7 +1,7 @@ --- -title: Running CodeQL code scanning in a container +title: Ejecutarel escaneo de código de CodeQL en un contenedor shortTitle: '{% data variables.product.prodname_code_scanning_capc %} in a container' -intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.' +intro: 'Puedes ejecutar el {% data variables.product.prodname_code_scanning %} en un contenedor si garantizas que todos los procesos se ejecutan en el mismo contenedor.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container @@ -21,42 +21,44 @@ topics: - Repositories - Containers - Java +ms.openlocfilehash: 60dac8a7f71af067c5cfaba5f48d123a3068f704 +ms.sourcegitcommit: aa488e9e641139f9056885b1479c8801e9906131 +ms.translationtype: HT +ms.contentlocale: es-ES +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148162811' --- - - {% data reusables.code-scanning.beta %} -## About {% data variables.product.prodname_code_scanning %} with a containerized build +## Acerca del {% data variables.product.prodname_code_scanning %} con una compilación en contenedor -If you're setting up {% data variables.product.prodname_code_scanning %} for a compiled language, and you're building the code in a containerized environment, the analysis may fail with the error message "No source code was seen during the build." This indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code as it was compiled. +Si estás configurando el {% data variables.product.prodname_code_scanning %} para un lenguaje compilado, y estás compilando el código en un ambiente contenido, el análisis podría fallar con el mensaje de error "No source code was seen during the build". Esto indica que {% data variables.product.prodname_codeql %} no fue capaz de monitorear tu código mientras se compilaba. -You must run {% data variables.product.prodname_codeql %} inside the container in which you build your code. This applies whether you are using the {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, the {% data variables.code-scanning.codeql_runner %},{% endif %} or {% data variables.product.prodname_actions %}. For the {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}or the {% data variables.code-scanning.codeql_runner %}{% endif %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} or "[Running {% data variables.code-scanning.codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} for more information. If you're using {% data variables.product.prodname_actions %}, configure your workflow to run all the actions in the same container. For more information, see "[Example workflow](#example-workflow)." +Debes ejecutar a {% data variables.product.prodname_codeql %} dentro del mismo contenedor en el que compilaste tu código. Esto se aplica ya sea si usas {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, {% data variables.code-scanning.codeql_runner %},{% endif %} o {% data variables.product.prodname_actions %}. Para {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}o {% data variables.code-scanning.codeql_runner %}{% endif %}, consulta "[Instalación de {% data variables.product.prodname_codeql_cli %} en el sistema de CI](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} o "[Ejecución de {% data variables.code-scanning.codeql_runner %} en el sistema de CI](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} para obtener más información. Si estás utilizando {% data variables.product.prodname_actions %}, configura tu flujo de trabajo para ejecutar todas las acciones en el mismo contenedor. Para obtener más información, vea "[Flujo de trabajo de ejemplo](#example-workflow)". {% note %} -**Note:** {% data reusables.code-scanning.non-glibc-linux-support %} +**Nota:** {% data reusables.code-scanning.non-glibc-linux-support %} {% endnote %} -## Dependencies +## Dependencias -You may have difficulty running {% data variables.product.prodname_code_scanning %} if the container you're using is missing certain dependencies (for example, Git must be installed and added to the PATH variable). If you encounter dependency issues, review the list of software typically included on {% data variables.product.prodname_dotcom %}'s runner images. For more information, see the version-specific `readme` files in these locations: +Es posible que tengas alguna dificultad para ejecutar el {% data variables.product.prodname_code_scanning %} si el contenedor que estás utilizando carece de ciertas dependencias (Por ejemplo, Git debe instalarse y agregarse a la variable PATH). Si te encuentras con algún problema en las dependencias, revisa la lista de software que habitualmente se incluye en las imágenes de ejecutores de {% data variables.product.prodname_dotcom %}. Para obtener más información, vea los archivos `readme` específicos de la versión en estas ubicaciones: * Linux: https://github.com/actions/runner-images/tree/main/images/linux * macOS: https://github.com/actions/runner-images/tree/main/images/macos * Windows: https://github.com/actions/runner-images/tree/main/images/win -## Example workflow +## Flujo de trabajo de ejemplo -{% ifversion ghes or ghae %} -{% note %} +{% ifversion ghes or ghae %} {% note %} -**Note:** This article describes the features available with the version of the CodeQL action and associated CodeQL CLI bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the CodeQL action, see the [{% data variables.product.prodname_ghe_cloud %} article](/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container) for information on the latest features.{% ifversion not ghae %} For information on using the latest version, see "[Configuring code scanning for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)."{% endif %} +**Nota:** En este artículo se describen las características disponibles con la versión de la acción CodeQL y el paquete CodeQL CLI asociado que se incluye en la versión inicial de esta versión de {% data variables.product.product_name %}. Si la empresa usa una versión más reciente de la acción CodeQL, vea el [artículo sobre {% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container) para obtener información sobre las características más recientes.{% ifversion not ghae %} Para obtener información sobre el uso de la versión más reciente, vea "[Configuración del examen de código para el dispositivo](/admin/advanced-security/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)".{% endif %} -{% endnote %} -{% endif %} +{% endnote %} {% endif %} -This sample workflow uses {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_codeql %} analysis in a containerized environment. The value of `container.image` identifies the container to use. In this example the image is named `codeql-container`, with a tag of `f0f91db`. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)." +Este flujo de trabajo de muestra utiliza {% data variables.product.prodname_actions %} para ejecutar un análisis de {% data variables.product.prodname_codeql %} en un ambiente contenido. El valor de `container.image` identifica el contenedor que se va a usar. En este ejemplo, la imagen se denomina `codeql-container`, con una etiqueta de `f0f91db`. Para más información, vea "[Sintaxis de flujo de trabajo para {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)". ``` yaml name: "{% data variables.product.prodname_codeql %}" diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index ed98f29737a3..e158e7d1c22e 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -1,7 +1,7 @@ --- -title: SARIF support for code scanning +title: Soporte de SARIF para escaneo de código shortTitle: SARIF support -intro: 'To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you''ll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically.' +intro: 'Para mostrar los resultados de una herramienta de análisis estático de terceros en tu repositorio en {% data variables.product.prodname_dotcom %}, necesitas que éstos se almacenen en un archivo SARIF que sea compatible con un subconjunto del modelo de JSON para SARIF 2.1.0 para el {% data variables.product.prodname_code_scanning %}. Si utilizas el motor de análisis estático predeterminado de {% data variables.product.prodname_codeql %}, tus resultados se mostrarán automáticamente en tu repositorio de {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -20,70 +20,74 @@ topics: - Code scanning - Integration - SARIF +ms.openlocfilehash: 98d0e4620d240c3e1863aaee6f57a5834c86018b +ms.sourcegitcommit: aa488e9e641139f9056885b1479c8801e9906131 +ms.translationtype: HT +ms.contentlocale: es-ES +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148162795' --- - - {% data reusables.code-scanning.beta %} -## About SARIF support +## Acerca del soporte de SARIF -SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema. +SARIF (Static Analysis Results Interchange Format) es un [estándar OASIS](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) que define un formato de archivo de salida. El estándar SARIF se utiliza para optimizar la manera en el que las herramientas de análisis estático comparten sus resultados. {% data variables.product.prodname_code_scanning_capc %} es compatible con un subconjunto del modelo SARIF 2.1.0 JSON. -To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). +Para cargar un archivo SARIF desde un motor de análisis estático de código desde un tercero, necesitaras asegurarte de que los archivos cargados utilicen la versión SARIF 2.1.0. {% data variables.product.prodname_dotcom %} analizará el archivo SARIF y mostrará las alertas utilizando los resultados en tu repositorio como parte de la experiencia del {% data variables.product.prodname_code_scanning %}. Para obtener más información, consulte "[Carga de un archivo SARIF en {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." Para obtener más información sobre el esquema de JSON SARIF 2.1.0, consulte [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). -If you're using {% data variables.product.prodname_actions %} with the {% data variables.code-scanning.codeql_workflow %}{% ifversion codeql-runner-supported %}, using the {% data variables.code-scanning.codeql_runner %},{% endif %} or using the {% data variables.product.prodname_codeql_cli %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)"{% ifversion codeql-runner-supported %}, "[Running {% data variables.code-scanning.codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)",{% endif %} or "[Installing CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)." +Si estás utilizando {% data variables.product.prodname_actions %} con {% data variables.code-scanning.codeql_workflow %}{% ifversion codeql-runner-supported %}, {% data variables.code-scanning.codeql_runner %},{% endif %} o {% data variables.product.prodname_codeql_cli %}, los resultados de {% data variables.product.prodname_code_scanning %} usarán automáticamente el subconjunto compatible de SARIF 2.1.0. Para más información, consulta "[Configuración de {% data variables.product.prodname_code_scanning %} para un repositorio](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)"{% ifversion codeql-runner-supported %}, "[Ejecución de {% data variables.code-scanning.codeql_runner %} en tu sistema de CI](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)",{% endif %} o "[Instalación de la CLI de CodeQL en tu sistema de CI](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)". -You can upload multiple SARIF files for the same commit, and display the data from each file as {% data variables.product.prodname_code_scanning %} results. When you upload multiple SARIF files for a commit, you must indicate a "category" for each analysis. The way to specify a category varies according to the analysis method: -- Using the {% data variables.product.prodname_codeql_cli %} directly, pass the `--sarif-category` argument to the `codeql database analyze` command when you generate SARIF files. For more information, see "[Configuring CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#about-generating-code-scanning-results-with-codeql-cli)." -- Using {% data variables.product.prodname_actions %} with `codeql-action/analyze`, the category is set automatically from the workflow name and any matrix variables (typically, `language`). You can override this by specifying a `category` input for the action, which is useful when you analyze different sections of a mono-repository in a single workflow. -- Using {% data variables.product.prodname_actions %} to upload results from other static analysis tools, then you must specify a `category` input if you upload more than one file of results for the same tool in one workflow. For more information, see "[Uploading a {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_actions %}](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." -- If you are not using either of these approaches, you must specify a unique `runAutomationDetails.id` in each SARIF file to upload. For more information about this property, see [`runAutomationDetails` object](#runautomationdetails-object) below. +Puedes cargar varios archivos SARIF para la misma confirmación y mostrar los datos de cada archivo como resultados del {% data variables.product.prodname_code_scanning %}. Cuando cargas varios archivos de SARIF en una confirmación, debes indicar una "Categoría" para cada análisis. La forma de especificar una categoría varía de acuerdo con el método de análisis: +- Si usa directamente {% data variables.product.prodname_codeql_cli %}, puede enviar el argumento `--sarif-category` al comando `codeql database analyze` cuando genere los archivos SARIF. Para obtener más información, consulte "[Configuración de la CLI de CodeQL en el sistema de CI](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#about-generating-code-scanning-results-with-codeql-cli)". +- Utilice {% data variables.product.prodname_actions %} con `codeql-action/analyze` para que la categoría se establezca automáticamente a partir del nombre del flujo de trabajo y las variables de matriz (normalmente, es `language`). Puede ignorar este ajuste si especifica una entrada en `category` para la acción, lo cual es útil cuando analiza diferentes secciones de un repositorio único en un flujo de trabajo simple. +- Si {% data variables.product.prodname_actions %} para cargar los resultados de otras herramientas de análisis estático, debe especificar una entrada en `category` si carga más de un archivo de resultados para la misma herramienta en un flujo de trabajo. Para obtener más información, consulte "[Carga de un análisis de {% data variables.product.prodname_code_scanning %} con {% data variables.product.prodname_actions %}](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)". +- Si no usa ninguno de estos enfoques, debe especificar un `runAutomationDetails.id` único en cada archivo SARIF que se va a cargar. Para obtener más información acerca de esta propiedad, consulte [Objeto de `runAutomationDetails`](#runautomationdetails-object) a continuación. -If you upload a second SARIF file for a commit with the same category and from the same tool, the earlier results are overwritten. However, if you try to upload multiple SARIF files for the same tool and category in a single {% data variables.product.prodname_actions %} workflow run, the misconfiguration is detected and the run will fail. +Si cargas un archivo de SARIF para una confirmación con la misma categoría y desde la misma herramienta, los resultados anteriores se sobreescribirán. Sin embargo, si intentas cargar varios archivos SARIF para la misma herramienta y categoría en una ejecución de flujo de trabajo de {% data variables.product.prodname_actions %} sencilla, esta configuración errónea se detectará y la ejecución fallará. -{% data variables.product.prodname_dotcom %} uses properties in the SARIF file to display alerts. For example, the `shortDescription` and `fullDescription` appear at the top of a {% data variables.product.prodname_code_scanning %} alert. The `location` allows {% data variables.product.prodname_dotcom %} to show annotations in your code file. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." +{% data variables.product.prodname_dotcom %} utiliza propiedades en el archivo SARIF para mostrar alertas. Por ejemplo, `shortDescription` y `fullDescription` aparecen en la parte superior de una alerta de {% data variables.product.prodname_code_scanning %}. `location` permite que {% data variables.product.prodname_dotcom %} muestre anotaciones en el archivo de código. Para obtener más información, consulte "[Administración de alertas de {% data variables.product.prodname_code_scanning %} para el repositorio](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)". -If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. +Si no está familiarizado con SARIF y quiere obtener más información, consulte el repositorio [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) de Microsoft. -## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs +## Proporcionar datos para realizar un seguimiento de las alertas de {% data variables.product.prodname_code_scanning %} entre ejecuciones -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. +Cada vez que se cargan los resultados de un nuevo examen de código, los resultados se procesan y se agregan alertas al repositorio. Para prevenir las alertas duplicadas para el mismo problema, {% data variables.product.prodname_code_scanning %} utiliza huellas dactilares para empatara los resultados a través de diversas ejecuciones para que solo aparezcan una vez en la última ejecución para la rama seleccionada. Esto hace posible emparejar las alertas con la línea de código correcta cuando se editan los archivos. El `ruleID` para un resultado debe ser el mismo en todo el análisis. -### Reporting consistent filepaths +### Informes de rutas de archivo coherentes -The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. +La ruta de acceso de archivo debe ser coherente en las ejecuciones para habilitar un cálculo de una huella digital estable. Si las rutas de archivo difieren para el mismo resultado, cada vez que se crea un nuevo análisis, se creará una nueva alerta y se cerrará la antigua. Esto provocará que haya varias alertas para el mismo resultado. -### Including data for fingerprint generation +### Inclusión de datos para la generación de huellas digitales -{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. +{% data variables.product.prodname_dotcom %} usa la propiedad `partialFingerprints` del estándar OASIS para detectar si hay dos resultados idénticos desde el punto de vista lógico. Para obtener más información, consulte la entrada "[propiedad partialFingerprints](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" en la documentación de OASIS. -SARIF files created by the {% data variables.code-scanning.codeql_workflow %}, {% ifversion codeql-runner-supported %}using the {% data variables.code-scanning.codeql_runner %}, {% endif %}or using the {% data variables.product.prodname_codeql_cli %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." +Los archivos SARIF que crea {% data variables.code-scanning.codeql_workflow %}, {% ifversion codeql-runner-supported %}mediante {% data variables.code-scanning.codeql_runner %}, {% endif %} {% data variables.product.prodname_codeql_cli %} incluyen datos de huellas digitales. Si carga un archivo SARIF con la acción `upload-sarif` y faltan estos datos, {% data variables.product.prodname_dotcom %} intenta rellenar el campo `partialFingerprints` a partir de los archivos de origen. Para obtener más información sobre la carga de resultados, consulte "[Carga de un archivo SARIF en {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." -If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)." +Si carga un archivo SARIF sin datos de huella digital utilizando el punto de conexión de la API `/code-scanning/sarifs`, se procesarán y se mostrarán las alertas del {% data variables.product.prodname_code_scanning %}, pero es posible que los usuarios vean alertas duplicadas. Para evitar ver alertas duplicadas, debe calcular los datos de huella digital y rellenar la propiedad `partialFingerprints` antes de cargar el archivo SARIF. Puede que el script que utiliza la acción `upload-sarif` le resulte un buen punto de partida: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. Para obtener más información sobre la API, consulte "[Carga de un análisis como datos de SARIF](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)". -## Understanding rules and results +## Descripción de las reglas y los resultados -SARIF files support both rules and results. The information stored in these elements is similar but serves different purposes. +Los archivos SARIF admiten reglas y resultados. La información almacenada en estos elementos es similar, pero sirve para diferentes propósitos. -- Rules are an array of `reportingDescriptor` objects that are included in the `toolComponent` object. This is where you store details of the rules that are run during analysis. Information in these objects should change infrequently, typically when you update the tool. +- Las reglas son una matriz de objetos `reportingDescriptor` que se incluyen en el objeto `toolComponent`. Aquí es donde almacenas los detalles de las reglas que se ejecutan durante el análisis. La información de estos objetos debe cambiar con poca frecuencia, normalmente al actualizar la herramienta. -- Results are stored as a series of `result` objects under `results` in the `run` object. Each `result` object contains details for one alert in the codebase. Within the `results` object, you can reference the rule that detected the alert. +- Los resultados se almacenan como una serie de objetos `result` en `results` en el objeto `run`. Cada objeto `result` contiene detalles de una alerta en el código base. Dentro del objeto `results`, puedes hacer referencia a la regla que ha detectado la alerta. -When you compare SARIF files generated by analyzing different codebases with the same tool and rules, you should see differences in the results of the analyses but not in the rules. +Al comparar los archivos SARIF generados mediante el análisis de diferentes bases de código con la misma herramienta y las mismas reglas, tendrías que ver diferencias en los resultados de los análisis, pero no en las reglas. -## Specifying the root for source files +## Especificación de la raíz para los archivos de origen -{% data variables.product.prodname_code_scanning_capc %} interprets results that are reported with relative paths as relative to the root of the repository analyzed. If a result contains an absolute URI, the URI is converted to a relative URI. The relative URI can then be matched against a file committed to the repository. +{% data variables.product.prodname_code_scanning_capc %} interpreta los resultados que se notifican con rutas de acceso relativas en relación con la raíz del repositorio analizado. Si un resultado contiene un URI absoluto, el URI se convierte en un URI relativo. A continuación, el URI relativo se puede emparejar con un archivo confirmado en el repositorio. -You can provide the source root for conversion from absolute to relative URIs in one of the following ways. +Puedes proporcionar la raíz de origen para la conversión de URI absolutos a relativos de una de las siguientes maneras. -- [`checkout_path`](https://github.com/github/codeql-action/blob/c2c0a2908e95769d01b907f9930050ecb5cf050d/analyze/action.yml#L44-L47) input to the `github/codeql-action/analyze` action -- `checkout_uri` parameter to the SARIF upload API endpoint. For more information, see "[{% data variables.product.prodname_code_scanning_capc %}](/rest/code-scanning#upload-an-analysis-as-sarif-data)" in the REST API documentation -- [`invocation.workingDirectory.uri`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html#_Toc9244365) property in the SARIF file +- [`checkout_path`](https://github.com/github/codeql-action/blob/c2c0a2908e95769d01b907f9930050ecb5cf050d/analyze/action.yml#L44-L47) entrada a la `github/codeql-action/analyze` acción +- `checkout_uri` parámetro al punto de conexión de la API de carga de SARIF. Para más información, consulta "[{% data variables.product.prodname_code_scanning_capc %}](/rest/code-scanning#upload-an-analysis-as-sarif-data)" en la documentación de la API REST +- [`invocation.workingDirectory.uri`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html#_Toc9244365) propiedad en el archivo de SARIF -If you provide a source root, any location of an artifact specified using an absolute URI must use the same URI scheme. If there is a mismatch between the URI scheme for the source root and one or more of the absolute URIs, the upload is rejected. +Si proporciona una raíz de origen, cualquier ubicación de un artefacto especificado mediante un URI absoluto debe usar el mismo esquema de URI. Si hay una discrepancia entre el esquema de URI para la raíz de origen y uno o varios de los URI absolutos, se rechaza la carga. -For example, a SARIF file is uploaded using a source root of `file:///github/workspace`. +Por ejemplo, un archivo SARIF se carga mediante una raíz de origen de `file:///github/workspace`. ``` # Conversion of absolute URIs to relative URIs for location artifacts @@ -92,133 +96,133 @@ file:///github/workspace/src/main.go -> src/main.go file:///tmp/go-build/tmp.go -> file:///tmp/go-build/tmp.go ``` -The file is successfully uploaded as both absolute URIs use the same URI scheme as the source root. +El archivo se carga correctamente, ya que ambos URI absolutos usan el mismo esquema de URI que la raíz de origen. -## Validating your SARIF file +## Validar tu archivo SARIF -You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/). +Puedes verificar si un archivo SARIF es compatible con el {% data variables.product.prodname_code_scanning %} si lo pruebas contra las reglas de ingestión de {% data variables.product.prodname_dotcom %}. Para obtener más información, visite el [validador de SARIF de Microsoft](https://sarifweb.azurewebsites.net/). {% data reusables.code-scanning.upload-sarif-alert-limit %} -## Supported SARIF output file properties +## Propiedades compatibles de archivo de salida SARIF -If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +Si utilizas un motor de análisis de código diferente a {% data variables.product.prodname_codeql %}, puedes revisar las propiedades SARIF compatibles para optimizar cómo aparecerán los resultados de tu análisis en {% data variables.product.prodname_dotcom %}. {% note %} -**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. +**Nota:** Debes proporcionar un valor explícito para cualquier propiedad marcada como "obligatoria". La cadena vacía no se admite para las propiedades necesarias. {% endnote %} -Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. +Puedes cargar cualquier archivo de salida SARIF 2.1.0 válido, sin embargo, {% data variables.product.prodname_code_scanning %} utilizará únicamente las siguientes propiedades compatibles. -### `sarifLog` object +### Objecto `sarifLog` -| Name | Description | +| Nombre | Descripción | |----|----| -| `$schema` | **Required.** The URI of the SARIF JSON schema for version 2.1.0. For example, `https://json.schemastore.org/sarif-2.1.0.json`. | -| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`. -| `runs[]` | **Required.** A SARIF file contains an array of one or more runs. Each run represents a single run of an analysis tool. For more information about a `run`, see the [`run` object](#run-object). +| `$schema` | **Obligatorio.** URI del esquema de JSON SARIF para la versión 2.1.0. Por ejemplo, `https://json.schemastore.org/sarif-2.1.0.json`. | +| `version` | **Obligatorio.** {% data variables.product.prodname_code_scanning_capc %} solo admite la versión `2.1.0` de SARIF. +| `runs[]` | **Obligatorio.** Un archivo SARIF contiene una matriz de una o varias ejecuciones. Cada ejecución representa una sola ejecución de una herramienta de análisis. Para obtener más información sobre un `run`, consulte el [objeto `run`](#run-object). -### `run` object +### Objecto `run` -{% data variables.product.prodname_code_scanning_capc %} uses the `run` object to filter results by tool and provide information about the source of a result. The `run` object contains the `tool.driver` tool component object, which contains information about the tool that generated the results. Each `run` can only have results for one analysis tool. +{% data variables.product.prodname_code_scanning_capc %} usa el objeto `run` para filtrar resultados por herramienta y proporcionar información sobre el origen de un resultado. El objeto `run` contiene el objeto de componente de herramienta `tool.driver`, que contiene información sobre la herramienta que generó los resultados. Cada `run` puede tener resultados para una sola herramienta de análisis. -| Name | Description | +| Nombre | Descripción | |----|----| -| `tool.driver` | **Required.** A `toolComponent` object that describes the analysis tool. For more information, see the [`toolComponent` object](#toolcomponent-object). | -| `tool.extensions[]` | **Optional.** An array of `toolComponent` objects that represent any plugins or extensions used by the tool during analysis. For more information, see the [`toolComponent` object](#toolcomponent-object). | -| `invocation.workingDirectory.uri` | **Optional.** This field is used only when `checkout_uri` (SARIF upload API only) or `checkout_path` ({% data variables.product.prodname_actions %} only) are not provided. The value is used to convert absolute URIs used in [`physicalLocation` objects](#physicallocation-object) to relative URIs. For more information, see "[Specifying the root for source files](#specifying-the-root-for-source-files)."| -| `results[]` | **Required.** The results of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the results on {% data variables.product.prodname_dotcom %}. For more information, see the [`result` object](#result-object). +| `tool.driver` | **Obligatorio.** Un objeto `toolComponent` que describe la herramienta de análisis. Para obtener más información, consulte el [objeto `toolComponent`](#toolcomponent-object). | +| `tool.extensions[]` | **Opcional.** Una matriz de objetos `toolComponent` que representan todos los complementos o extensiones usados por la herramienta durante el análisis. Para obtener más información, consulte el [objeto `toolComponent`](#toolcomponent-object). | +| `invocation.workingDirectory.uri` | **Opcional.** Este campo solo se utiliza cuando no se proporciona `checkout_uri` (solo API de carga de SARIF) o `checkout_path` (solo {% data variables.product.prodname_actions %}). El valor se usa para convertir URI absolutos usados en [`physicalLocation` objetos](#physicallocation-object) en URI relativos. Para obtener más información, consulta "[Especificar la raíz para los archivos de origen](#specifying-the-root-for-source-files)".| +| `results[]` | **Obligatorio.** Resultados de la herramienta de análisis. {% data variables.product.prodname_code_scanning_capc %} muestra los resultados en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulte el [objeto `result`](#result-object). -### `toolComponent` object +### Objecto `toolComponent` -| Name | Description | +| Nombre | Descripción | |----|----| -| `name` | **Required.** The name of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the name on {% data variables.product.prodname_dotcom %} to allow you to filter results by tool. | -| `version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. | -| `semanticVersion` | **Optional.** The version of the analysis tool, specified by the Semantic Versioning 2.0 format. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. For more information, see "[Semantic Versioning 2.0.0](https://semver.org/)" in the Semantic Versioning documentation. | -| `rules[]` | **Required.** An array of `reportingDescriptor` objects that represent rules. The analysis tool uses rules to find problems in the code being analyzed. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). | +| `name` | **Obligatorio.** Nombre de la herramienta de análisis. {% data variables.product.prodname_code_scanning_capc %} muestra el nombre en {% data variables.product.prodname_dotcom %} para permitirte filtrar los resultados por herramienta. | +| `version` | **Opcional.** Versión de la herramienta de análisis. {% data variables.product.prodname_code_scanning_capc %} utiliza el número de versión para rastrear cuando los resultados pudieran haber cambiado debido al cambio de versión en la herramienta en vez de debido a un cambio del código que se analiza. Si el archivo SARIF incluye el campo `semanticVersion`, el {% data variables.product.prodname_code_scanning %} no usa `version`. | +| `semanticVersion` | **Opcional.** Versión de la herramienta de análisis, especificada por el formato Versionamiento Semántico 2.0. {% data variables.product.prodname_code_scanning_capc %} utiliza el número de versión para rastrear cuando los resultados pudieran haber cambiado debido al cambio de versión en la herramienta en vez de debido a un cambio del código que se analiza. Si el archivo SARIF incluye el campo `semanticVersion`, el {% data variables.product.prodname_code_scanning %} no usa `version`. Para obtener más información, consulte "[Versionamiento Semántico 2.0.0](https://semver.org/)" en la documentación sobre Versionamiento Semántico. | +| `rules[]` | **Obligatorio.** Matriz de objetos `reportingDescriptor` que representan reglas. La herramienta de análisis utiliza reglas para encontrar problemas en el código que se analiza. Para obtener más información, consulte el [objeto `reportingDescriptor`](#reportingdescriptor-object). | -### `reportingDescriptor` object +### Objecto `reportingDescriptor` -This is where you store details of the rules that are run during analysis. Information in these objects should change infrequently, typically when you update the tool. For more information, see "[Understanding rules and results](#understanding-rules-and-results)" above. +Aquí es donde almacenas los detalles de las reglas que se ejecutan durante el análisis. La información de estos objetos debe cambiar con poca frecuencia, normalmente al actualizar la herramienta. Para obtener más información, consulta "[Descripción de las reglas y los resultados](#understanding-rules-and-results)" más arriba. -| Name | Description | +| Nombre | Descripción | |----|----| -| `id` | **Required.** A unique identifier for the rule. The `id` is referenced from other parts of the SARIF file and may be used by {% data variables.product.prodname_code_scanning %} to display URLs on {% data variables.product.prodname_dotcom %}. | -| `name` | **Optional.** The name of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the name to allow results to be filtered by rule on {% data variables.product.prodname_dotcom %}. | -| `shortDescription.text` | **Required.** A concise description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the short description on {% data variables.product.prodname_dotcom %} next to the associated results. -| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000. -| `defaultConfiguration.level` | **Optional.** Default severity level of the rule. {% data variables.product.prodname_code_scanning_capc %} uses severity levels to help you understand how critical the result is for a given rule. This value can be overridden by the `level` attribute in the `result` object. For more information, see the [`result` object](#result-object). Default: `warning`. -| `help.text` | **Required.** Documentation for the rule using text format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. -| `help.markdown` | **Recommended.** Documentation for the rule using Markdown format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. When `help.markdown` is available, it is displayed instead of `help.text`. -| `properties.tags[]` | **Optional.** An array of strings. {% data variables.product.prodname_code_scanning_capc %} uses `tags` to allow you to filter results on {% data variables.product.prodname_dotcom %}. For example, it is possible to filter to all results that have the tag `security`. -| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`. -| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. -| `properties.security-severity` | **Recommended.** A string representing a score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. - -### `result` object - -Each `result` object contains details for one alert in the codebase. Within the `results` object, you can reference the rule that detected the alert. For more information, see "[Understanding rules and results](#understanding-rules-and-results)" above. +| `id` | **Obligatorio.** Identificador único para la regla. Al `id` se hace referencia desde otras secciones del archivo SARIF, y se puede usar en el {% data variables.product.prodname_code_scanning %} para mostrar las URL en {% data variables.product.prodname_dotcom %}. | +| `name` | **Opcional.** Nombre de la regla. {% data variables.product.prodname_code_scanning_capc %} muestra el nombre para permitir que se filtren los resultados por regla en {% data variables.product.prodname_dotcom %}. | +| `shortDescription.text` | **Obligatorio.** Descripción concisa de la regla. {% data variables.product.prodname_code_scanning_capc %} muestra la descripción corta en {% data variables.product.prodname_dotcom %} junto a los resultados asociados. +| `fullDescription.text` | **Obligatorio.** Una descripción de la regla. {% data variables.product.prodname_code_scanning_capc %} muestra la descripción completa en {% data variables.product.prodname_dotcom %} junto a los resultados asociados. La cantidad máxma de caracteres se limita a 1000. +| `defaultConfiguration.level` | **Opcional.** Nivel de gravedad predeterminado de la regla. {% data variables.product.prodname_code_scanning_capc %} utiliza niveles de severidad para ayudarte a entender qué tan crítico es el resultado de una regla. El atributo `level` del objeto `result` puede invalidar este valor. Para obtener más información, consulte el [objeto `result`](#result-object). Predeterminado: `warning`. +| `help.text` | **Obligatorio.** Documentación de la regla con formato de texto. {% data variables.product.prodname_code_scanning_capc %} muestra esta documentación de ayuda junto a los resultados asociados. +| `help.markdown` | **Opción recomendada.** Documentación de la regla con formato de Markdown. {% data variables.product.prodname_code_scanning_capc %} muestra esta documentación de ayuda junto a los resultados asociados. Cuando `help.markdown` está disponible, se muestra en lugar de `help.text`. +| `properties.tags[]` | **Opcional.** Una matriz de cadenas. {% data variables.product.prodname_code_scanning_capc %} usa `tags` para permitirle filtrar resultados en {% data variables.product.prodname_dotcom %}. Por ejemplo, es posible filtrar todos los resultados que tengan la etiqueta `security`. +| `properties.precision` | **Opción recomendada.** Cadena que indica con qué frecuencia se cumplen los resultados indicados por esta regla. Por ejemplo, si una regla tiene una tasa alta de falsos positivos, la precisión debería ser `low`. {% data variables.product.prodname_code_scanning_capc %} ordena los resultados de acuerdo con su precisión en {% data variables.product.prodname_dotcom %} para que aquellos con el `level` y el `precision` más altos aparezcan primero. Puede ser `very-high`, `high`, `medium` o `low`. +| `properties.problem.severity` | **Opción recomendada.** Cadena que indica el nivel de gravedad de las alertas generadas por una consulta que no sea de seguridad. Esto, junto con la propiedad `properties.precision`, determina si los resultados se muestran de manera predeterminada en {% data variables.product.prodname_dotcom %} para que los resultados con el `problem.severity` y el `precision` más altos aparezcan primero. Puede ser de tipo `error`, `warning` o `recommendation`. +| `properties.security-severity` | **Opción recomendada.** Cadena que representa una puntuación que indica el nivel de gravedad, entre 0,0 y 10,0, de las consultas de seguridad (`@tags` incluye `security`). Esto, junto con la propiedad `properties.precision`, determina si los resultados se muestran de manera predeterminada en {% data variables.product.prodname_dotcom %} para que los resultados con el `security-severity` y el `precision` más altos aparezcan primero. {% data variables.product.prodname_code_scanning_capc %} traduce las puntuaciones numéricas de la siguiente manera: más de 9,0 es`critical`, entre 7,0 y 8,9 es `high`, entre 4,0 y 6,9 es `medium` y menos de 3,9 o 3,9 es `low`. + +### Objecto `result` + +Cada objeto `result` contiene detalles de una alerta en el código base. Dentro del objeto `results`, puedes hacer referencia a la regla que ha detectado la alerta. Para obtener más información, consulta "[Descripción de las reglas y los resultados](#understanding-rules-and-results)" más arriba. {% data reusables.code-scanning.upload-sarif-alert-limit %} -| Name | Description | +| Nombre | Descripción | |----|----| -| `ruleId`| **Optional.** The unique identifier of the rule (`reportingDescriptor.id`). For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} uses the rule identifier to filter results by rule on {% data variables.product.prodname_dotcom %}. -| `ruleIndex`| **Optional.** The index of the associated rule (`reportingDescriptor` object) in the tool component `rules` array. For more information, see the [`run` object](#run-object). The allowed range for this property 0 to 2^63 - 1. -| `rule`| **Optional.** A reference used to locate the rule (reporting descriptor) for this result. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). -| `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. -| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. -| `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. -| `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). -| `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). +| `ruleId`| **Opcional.** Identificador único de la regla (`reportingDescriptor.id`). Para obtener más información, consulte el [objeto `reportingDescriptor`](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} utiliza el identificador de reglas para filtrar los resultados por regla en {% data variables.product.prodname_dotcom %}. +| `ruleIndex`| **Opcional.** Índice de la regla asociada (objeto `reportingDescriptor`) en la matriz `rules` de componentes de herramienta. Para obtener más información, consulte el [objeto `run`](#run-object). El rango permitido para esta propiedad de 0 to 2^63 - 1. +| `rule`| **Opcional.** Referencia usada para buscar la regla (descriptor de informes) de este resultado. Para obtener más información, consulte el [objeto `reportingDescriptor`](#reportingdescriptor-object). +| `level`| **Opcional.** Gravedad del resultado. Este nivel invalida la severidad predeterminada que se define en la regla. {% data variables.product.prodname_code_scanning_capc %} utiliza el nivel para filtrar los resultados en {% data variables.product.prodname_dotcom %} por severidad. +| `message.text`| **Obligatorio.** Mensaje que describe el resultado. {% data variables.product.prodname_code_scanning_capc %} muestra el texto del mensaje como el título del resultado. Se mostrará únicamente la primera oración del mensaje cuando el espacio visible esté limitado. +| `locations[]`| **Obligatorio.** Conjunto de ubicaciones donde se detectó el resultado (hasta un máximo de 10). Sólo se deberá incluir una ubicación a menos de que el problema solo pueda corregirse realizando un cambio en cada ubicación especificada. **Nota:** Se requiere al menos una ubicación para que {% data variables.product.prodname_code_scanning %} muestre el resultado. {% data variables.product.prodname_code_scanning_capc %} utilizará esta propiedad para decidir qué archivo anotar con el resultado. Únicamente si se utiliza el primer valor de este arreglo. Se ignorará al resto de los otros valores. +| `partialFingerprints`| **Obligatorio.** Conjunto de cadenas usadas para realizar un seguimiento de la identidad única del resultado. {% data variables.product.prodname_code_scanning_capc %} usa `partialFingerprints` para identificar con precisión los resultados que son iguales en todas las confirmaciones y ramas. {% data variables.product.prodname_code_scanning_capc %} intentará usar `partialFingerprints` si están presentes. Si va a cargar archivos SARIF de terceros con `upload-action`, la acción creará `partialFingerprints` automáticamente cuando no se incluyan en el archivo SARIF. Para obtener más información, consulta "[Proporcionar datos para realizar un seguimiento de las alertas de análisis de código entre ejecuciones](#providing-data-to-track-code-scanning-alerts-across-runs)". **Nota:** {% data variables.product.prodname_code_scanning_capc %} solo usa `primaryLocationLineHash`. +| `codeFlows[].threadFlows[].locations[]`| **Opcional.** Matriz de objetos `location` para un objeto `threadFlow`, que describe el progreso de un programa a través de un subproceso de ejecución. Un objeto `codeFlow` describe un patrón de ejecución de código utilizado para detectar un resultado. Si se proporcionan flujos de código, {% data variables.product.prodname_code_scanning %} los expandirá en {% data variables.product.prodname_dotcom %} para el resultado relevante. Para obtener más información, consulte el [objeto `location`](#location-object). +| `relatedLocations[]`| Un conjunto de ubicaciones relevantes para el resultado. {% data variables.product.prodname_code_scanning_capc %} vinculará las ubicaciones cuando se incorporen en el mensaje de resultado. Para obtener más información, consulte el [objeto `location`](#location-object). -### `location` object +### Objecto `location` -A location within a programming artifact, such as a file in the repository or a file that was generated during a build. +Una ubicación dentro de un artefacto de programación, tal como un archivo en el repositorio o un archivo que se generó durante una compilación. -| Name | Description | +| Nombre | Descripción | |----|----| -| `location.id` | **Optional.** A unique identifier that distinguishes this location from all other locations within a single result object. The allowed range for this property 0 to 2^63 - 1. -| `location.physicalLocation` | **Required.** Identifies the artifact and region. For more information, see the [`physicalLocation`](#physicallocation-object). -| `location.message.text` | **Optional.** A message relevant to the location. +| `location.id` | **Opcional.** Identificador único que distingue esta ubicación de todas las demás ubicaciones dentro de un único objeto de resultado. El rango permitido para esta propiedad de 0 to 2^63 - 1. +| `location.physicalLocation` | **Obligatorio.** Identifica el artefacto y la región. Para obtener más información, consulte [`physicalLocation`](#physicallocation-object). +| `location.message.text` | **Opcional.** Mensaje relevante para la ubicación. -### `physicalLocation` object +### Objecto `physicalLocation` -| Name | Description | +| Nombre | Descripción | |----|----| -| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. For the best results we recommend that this is a relative path from the root of the GitHub repository being analyzed. For example, `src/main.js`. For more information about artifact URIs, see "[Specifying the root for source files](#specifying-the-root-for-source-files)."| -| `region.startLine` | **Required.** The line number of the first character in the region. -| `region.startColumn` | **Required.** The column number of the first character in the region. -| `region.endLine` | **Required.** The line number of the last character in the region. -| `region.endColumn` | **Required.** The column number of the character following the end of the region. +| `artifactLocation.uri`| **Obligatorio.** URI que indica la ubicación de un artefacto, normalmente un archivo del repositorio o generado durante una compilación. Para obtener los mejores resultados, se recomienda que se trata de una ruta de acceso relativa de la raíz del repositorio de GitHub que se está analizando. Por ejemplo, `src/main.js`. Para obtener más información sobre los URI de artefacto, consulta "[Especificación de la raíz para los archivos de origen](#specifying-the-root-for-source-files)".| +| `region.startLine` | **Obligatorio.** Número de línea del primer carácter de la región. +| `region.startColumn` | **Obligatorio.** Número de columna del primer carácter de la región. +| `region.endLine` | **Obligatorio.** Número de línea del último carácter de la región. +| `region.endColumn` | **Obligatorio.** Número de columna del carácter que sigue al final de la región. -### `runAutomationDetails` object +### Objecto `runAutomationDetails` -The `runAutomationDetails` object contains information that specifies the identity of a run. +El objeto `runAutomationDetails` contiene información que especifica la identidad de una ejecución. {% note %} -**Note:** `runAutomationDetails` is a SARIF v2.1.0 object. If you're using the {% data variables.product.prodname_codeql_cli %}, you can specify the version of SARIF to use. The equivalent object to `runAutomationDetails` is `.automationId` for SARIF v1 and `.automationLogicalId` for SARIF v2. +**Nota:** `runAutomationDetails` es un objeto de SARIF v2.1.0. Si estás utilizando el {% data variables.product.prodname_codeql_cli %}, puedes especificar la versión de SARIF a utilizar. El objeto equivalente a `runAutomationDetails` es `.automationId` para SARIF v1 y `.automationLogicalId` para SARIF v2. {% endnote %} -| Name | Description | +| Nombre | Descripción | |----|----| -| `id`| **Optional.** A string that identifies the category of the analysis and the run ID. Use if you want to upload multiple SARIF files for the same tool and commit, but performed on different languages or different parts of the code. | +| `id`| **Opcional.** Cadena que identifica la categoría del análisis y el identificador de ejecución. Utilízala si quieres cargar varios archivos SARIF para la misma herramienta y confirmación, pero que se realice en diferentes lenguajes o partes del código. | -The use of the `runAutomationDetails` object is optional. +El uso del objeto `runAutomationDetails` es opcional. -The `id` field can include an analysis category and a run ID. We don't use the run ID part of the `id` field, but we store it. +El campo `id` puede incluir una categoría de análisis y un identificador de ejecución. No usamos la parte del identificador de ejecución del campo `id`, pero la almacenamos. -Use the category to distinguish between multiple analyses for the same tool or commit, but performed on different languages or different parts of the code. Use the run ID to identify the specific run of the analysis, such as the date the analysis was run. +Utiliza la categoría para distinguir entre los diversos análisis de la misma herramienta o confirmación, pero cuando se llevan a cabo en diferentes lenguajes o en partes diferentes del código. Utiliza la ID de ejecución para identificar la ejecución específica del análisis, tal como la fecha en la que este se ejecutó. -`id` is interpreted as `category/run-id`. If the `id` contains no forward slash (`/`), then the entire string is the `run_id` and the `category` is empty. Otherwise, `category` is everything in the string until the last forward slash, and `run_id` is everything after. +`id` se interpreta como `category/run-id`. Si `id` no contiene ninguna barra diagonal (`/`), la cadena completa es la `run_id` y la `category` está vacía. De lo contrario, `category` será todo lo que aparezca en la cadena hasta la última barra diagonal, y `run_id` el resto. | `id` | category | `run_id` | |----|----|----| @@ -226,21 +230,21 @@ Use the category to distinguish between multiple analyses for the same tool or c | my-analysis/tool1/ | my-analysis/tool1 | _no `run-id`_ | my-analysis for tool1 | _no category_ | my-analysis for tool1 -- The run with an `id` of "my-analysis/tool1/2021-02-01" belongs to the category "my-analysis/tool1". Presumably, this is the run from February 2, 2021. -- The run with an `id` of "my-analysis/tool1/" belongs to the category "my-analysis/tool1" but is not distinguished from other runs in that category. -- The run whose `id` is "my-analysis for tool1 " has a unique identifier but cannot be inferred to belong to any category. +- La ejecución con un `id` de "my-analysis/tool1/2021-02-01" pertenece a la categoría "my-analysis/tool1". Supuestamente, esta es la ejecución del 2 de febrero de 2021. +- La ejecución con un `id` de "my-analysis/tool1/" pertenece a la cateogría "my-analysis/tool1", pero no se distingue de otras ejecuciones de esa categoría. +- La ejecución cuyo `id` es "my-analysis for tool1 " tiene un identificador único, pero no se puede inferir que pertenezca a alguna categoría. -For more information about the `runAutomationDetails` object and the `id` field, see [runAutomationDetails object](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) in the OASIS documentation. +Para obtener más información sobre el objeto `runAutomationDetails` y el campo `id`, consulte [Objeto runAutomationDetails](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) en la documentación de OASIS. -Note that the rest of the supported fields are ignored. +Nota que el resto de los campos compatibles se ignorarán. -## SARIF output file examples +## Ejemplos de archivo de salida SARIF -These example SARIF output files show supported properties and example values. +Estos ejemplos de archivos de salida SARIF muestran las propiedades compatibles y los valores de ejemplo. -### Example with minimum required properties +### Ejemplo con las propiedades mínimas requeridas -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +Este archivo de salida SARIF tiene valores de ejemplo para mostrar las propiedades mínimas requeridas para que los resultados de {% data variables.product.prodname_code_scanning %} funcionen como se espera. Si eliminas cualquier propiedad u omites valores, o si usas una cadena vacía, estos datos no se mostrarán correctamente ni se sincronizarán en {% data variables.product.prodname_dotcom %}. ```json { @@ -296,9 +300,9 @@ This SARIF output file has example values to show the minimum required propertie } ``` -### Example showing all supported SARIF properties +### Ejemplo que muestra todas las propiedades compatibles con SARIF -This SARIF output file has example values to show all supported SARIF properties for {% data variables.product.prodname_code_scanning %}. +Este archivo de salida SARIF tiene valores ejemplo para mostrar todas las propiedades de SARIF compatibles con {% data variables.product.prodname_code_scanning %}. ```json { diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md index a2d8162af9ea..630a508e5b7f 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md @@ -1,7 +1,7 @@ --- -title: Migrating from the CodeQL runner to CodeQL CLI +title: Migrarse del ejecutor de CodeQL al CLI de CodeQL shortTitle: Migrating from the CodeQL runner -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to complete the same tasks as with the {% data variables.code-scanning.codeql_runner %}.' +intro: 'Puedes utilizar {% data variables.product.prodname_codeql_cli %} para completar las mismas tareas que hacías con {% data variables.code-scanning.codeql_runner %}.' product: '{% data reusables.gated-features.code-scanning %}' versions: fpt: '*' @@ -12,52 +12,57 @@ topics: - Advanced Security - Code scanning - CodeQL +ms.openlocfilehash: 10711111e3fa5c7226574ac9b70eb4bd4d5bff21 +ms.sourcegitcommit: b617c4a7a1e4bf2de3987a86e0eb217d7031490f +ms.translationtype: HT +ms.contentlocale: es-ES +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148161268' --- +# Migración de {% data variables.code-scanning.codeql_runner %} a {% data variables.product.prodname_codeql_cli %} -# Migrating from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %} +{% data variables.code-scanning.codeql_runner %} se está dejando de usar. Puedes utilizar la versión 2.6.2 del {% data variables.product.prodname_codeql_cli %} y superiores. +Este documento describe cómo migrar flujos de trabajo comunes desde {% data variables.code-scanning.codeql_runner %} hasta {% data variables.product.prodname_codeql_cli %}. -The {% data variables.code-scanning.codeql_runner %} is being deprecated. You can use the {% data variables.product.prodname_codeql_cli %} version 2.6.2 and greater instead. -This document describes how to migrate common workflows from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %}. +## Instalación -## Installation +Descarga el **paquete {% data variables.product.prodname_codeql %}** del [repositorio `github/codeql-action`](https://github.com/github/codeql-action/releases). Este paquete contiene al {% data variables.product.prodname_codeql_cli %} y las consultas estándar y librerías de {% data variables.product.prodname_codeql %}. -Download the **{% data variables.product.prodname_codeql %} bundle** from the [`github/codeql-action` repository](https://github.com/github/codeql-action/releases). This bundle contains the {% data variables.product.prodname_codeql_cli %} and the standard {% data variables.product.prodname_codeql %} queries and libraries. +Para más información sobre cómo configurar {% data variables.product.prodname_codeql_cli %}, consulta "[Instalación de {% data variables.product.prodname_codeql_cli %} en el sistema de CI](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)". -For more information on setting up the {% data variables.product.prodname_codeql_cli %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)." +## Resumen de los cambios en los flujos de trabajo -## Overview of workflow changes +Un flujo de trabajo habitual que utiliza {% data variables.code-scanning.codeql_runner %} para analizar una base de código tiene los siguientes pasos. +- `codeql-runner- init` para empezar a crear bases de datos de {% data variables.product.prodname_codeql %} y leer la configuración. +- Para lenguajes compilados: establece las variables de entorno generadas por el paso `init`. +- Para los lenguajes compilados: ejecuta la autocompilación o los pasos de compilación manual. +- `codeql-runner- analyze` para terminar de crear bases de datos de {% data variables.product.prodname_codeql %}, ejecuta consultas para analizar cada base de datos de {% data variables.product.prodname_codeql %}, resume los resultados en un archivo SARIF y cárgalos en {% data variables.product.prodname_dotcom %}. -A typical workflow that uses the {% data variables.code-scanning.codeql_runner %} to analyze a codebase has the following steps. -- `codeql-runner- init` to start creating {% data variables.product.prodname_codeql %} databases and read the configuration. -- For compiled languages: set environment variables produced by the `init` step. -- For compiled languages: run autobuild or manual build steps. -- `codeql-runner- analyze` to finish creating {% data variables.product.prodname_codeql %} databases, run queries to analyze each {% data variables.product.prodname_codeql %} database, summarize the results in a SARIF file, and upload the results to {% data variables.product.prodname_dotcom %}. +Un flujo de trabajo habitual utiliza el {% data variables.product.prodname_codeql_cli %} para analizar una base de código tiene los siguientes pasos. +- `codeql database create` para crear bases de datos de {% data variables.product.prodname_codeql %}. + - Para los lenguajes compilados: Proporciona un comando de compilación opcionalmente. +- `codeql database analyze` para ejecutar consultas para analizar cada base de datos de {% data variables.product.prodname_codeql %} y resumir los resultados en un archivo SARIF. Este comando debe ejecutarse una vez para cada lenguaje o base de datos. +- `codeql github upload-results` para cargar los archivos SARIF resultantes en {% data variables.product.prodname_dotcom %}, que se mostrarán como alertas de examen de código. Este comando debe ejecutarse una vez para cada archivo SARIF o lenguaje. -A typical workflow that uses the {% data variables.product.prodname_codeql_cli %} to analyze a codebase has the following steps. -- `codeql database create` to create {% data variables.product.prodname_codeql %} databases. - - For compiled languages: Optionally provide a build command. -- `codeql database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. This command must be run once for each language or database. -- `codeql github upload-results` to upload the resulting SARIF files to {% data variables.product.prodname_dotcom %}, to be displayed as code scanning alerts. This command must be run once for each language or SARIF file. +{% data variables.code-scanning.codeql_runner %} tiene capacidades de multiproceso de forma predeterminada. El {% data variables.product.prodname_codeql_cli %} solo utiliza un subproceso predeterminadamente, pero te permite especificar la cantidad de subprocesos que quieres utilizar. Si quieres replicar el comportamiento de {% data variables.code-scanning.codeql_runner %} para usar todos los subprocesos disponibles en la máquina al utilizar {% data variables.product.prodname_codeql_cli %}, puedes pasar `--threads 0` a `codeql database analyze`. -The {% data variables.code-scanning.codeql_runner %} is multithreaded by default. The {% data variables.product.prodname_codeql_cli %} only uses a single thread by default, but allows you to specify the amount of threads you want it to use. If you want to replicate the behavior of the {% data variables.code-scanning.codeql_runner %} to use all threads available on the machine when using the {% data variables.product.prodname_codeql_cli %}, you can pass `--threads 0` to `codeql database analyze`. +Para más información, consulta "[Configuración de {% data variables.product.prodname_codeql_cli %} en el sistema de CI](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)". -For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." +## Ejemplos de usos comunes para el {% data variables.product.prodname_codeql_cli %} -## Examples of common uses for the {% data variables.product.prodname_codeql_cli %} +### Acerca de los ejemplos -### About the examples +Estos ejemplos asumen que el código fuente se verificó en el directorio de trabajo actual. Si usas un directorio diferente, cambia el argumento `--source-root` y los pasos de compilación en consecuencia. -These examples assume that the source code has been checked out to the current working directory. If you use a different directory, change the `--source-root` argument and the build steps accordingly. +Estos ejemplos también asumen que el {% data variables.product.prodname_codeql_cli %} se coloca en la RUTA correcta. -These examples also assume that the {% data variables.product.prodname_codeql_cli %} is placed on the current PATH. +En estos ejemplos, un token de {% data variables.product.prodname_dotcom %} con ámbitos adecuados se almacena en la variable de entorno `$TOKEN` y se pasa a los comandos de ejemplo a través de `stdin` o se almacena en la variable de entorno `$GITHUB_TOKEN`. -In these examples, a {% data variables.product.prodname_dotcom %} token with suitable scopes is stored in the `$TOKEN` environment variable and passed to the example commands via `stdin`, or is stored in the `$GITHUB_TOKEN` environment variable. +El nombre de ref y el SHA de confirmación que se verifican y analizan en estos ejemplos se conocen durante el flujo de trabajo. Para una rama, usa `refs/heads/BRANCH-NAME` como referencia. Para la confirmación principal de una solicitud de incorporación de cambios, usa `refs/pull/NUMBER/head`. Para una confirmación de combinación generada por {% data variables.product.prodname_dotcom %}, usa `refs/pull/NUMBER/merge`. En los ejemplos siguientes se usa `refs/heads/main`. Si utilizas un nombre de rama diferente, debes modificar el código de muestra. -The ref name and commit SHA being checked out and analyzed in these examples are known during the workflow. For a branch, use `refs/heads/BRANCH-NAME` as the ref. For the head commit of a pull request, use `refs/pull/NUMBER/head`. For a {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request, use `refs/pull/NUMBER/merge`. The examples below all use `refs/heads/main`. If you use a different branch name, you must modify the sample code. +### Lenguaje sencillo no compilado (JavaScript) -### Single non-compiled language (JavaScript) - -Runner: +Ejecutor: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -82,11 +87,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single non-compiled language (JavaScript) using a different query suite (security-and-quality) +### Lenguaje sencillo no compilado (JavaScript) utilizando una suite de consultas (security-and-quality) -A similar approach can be taken for compiled languages, or multiple languages. +Se puede tomar un enfoque similar para los lenguajes compilados o los lenguajes múltiples. -Runner: +Ejecutor: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -112,11 +117,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single non-compiled language (JavaScript) using a custom configuration file +### Lenguaje sencillo no compilado (JavaScript) utilizando un archivo de configuración personalizado -A similar approach can be taken for compiled languages, or multiple languages. +Se puede tomar un enfoque similar para los lenguajes compilados o los lenguajes múltiples. -Runner: +Ejecutor: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -143,9 +148,9 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single compiled language using autobuild (Java) +### Lenguaje sencillo no compilado utilizando compilación automática (Java) -Runner: +Ejecutor: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages java \ @@ -177,9 +182,9 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-java.sarif --github-auth-stdin ``` -### Single compiled language using a custom build command (Java) +### Lenguaje sencillo no copilado utilizando un comando de compilación personalizado (Java) -Runner: +Ejecutor: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages java \ @@ -210,11 +215,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-java.sarif --github-auth-stdin ``` -### Single compiled language using indirect build tracing (C# on Windows within Azure DevOps) +### Lenguaje sencillo no compilado utilizando rastreo de compilación indirecto (C# sobre Windows dentro de Azure DevOps) -Indirect build tracing for a compiled language enables {% data variables.product.prodname_codeql %} to detect all build steps between the `init` and `analyze` steps, when the code cannot be built using the autobuilder or an explicit build command line. This is useful when using preconfigured build steps from your CI system, such as the `VSBuild` and `MSBuild` tasks in Azure DevOps. +El seguimiento indirecto de la compilación de un lenguaje compilado permite que {% data variables.product.prodname_codeql %} detecte todos los pasos de compilación entre los pasos `init` y `analyze`, cuando el código no se puede compilar mediante el compilador automático o una línea de comandos de compilación explícita. Esta opción resulta útil cuando se usan pasos de compilación preconfigurados desde el sistema de CI, como las tareas `VSBuild` y `MSBuild` en Azure DevOps. -Runner: +Ejecutor: ```yaml - task: CmdLine@1 displayName: CodeQL Initialization @@ -332,12 +337,12 @@ CLI: ``` -### Multiple languages using autobuild (C++, Python) +### Lenguajes múltiples utilizando compilación automática (C++, Python) -This example is not strictly possible with the {% data variables.code-scanning.codeql_runner %}. -Only one language (the compiled language with the most files) will be analyzed. +Este ejemplo no es estrictamente posible con {% data variables.code-scanning.codeql_runner %}. +Solo se analizará un lenguaje (el lenguaje compilado que tenga la mayoría de los archivos). -Runner: +Ejecutor: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages cpp,python \ @@ -375,9 +380,9 @@ for language in cpp python; do done ``` -### Multiple languages using a custom build command (C++, Python) +### Lenguajes múltiples utilizando un comando de compilación personalizado (C++, Python) -Runner: +Ejecutor: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages cpp,python \ diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md index 0e56df084315..692b4c28a681 100644 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md +++ b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md @@ -20,7 +20,13 @@ shortTitle: GPG verification After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_github_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." -Once you enable GPG verification, it will immediately take effect for all your codespaces. +{% data reusables.codespaces.gpg-in-active-codespaces %} + +{% note %} + +**Note:** If you have linked a dotfiles repository with {% data variables.product.prodname_github_codespaces %}, the Git configuration in your dotfiles may conflict with the configuration that {% data variables.product.prodname_github_codespaces %} requires to sign commits. For more information, see "[Troubleshooting GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces)." + +{% endnote %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} @@ -30,8 +36,4 @@ Once you enable GPG verification, it will immediately take effect for all your c !["Selected repositories" dropdown menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) -{% note %} - -**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, you also must append `-S` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings. - -{% endnote %} +Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, all commits are signed by default in your codespaces. \ No newline at end of file diff --git a/translations/es-ES/content/codespaces/troubleshooting/index.md b/translations/es-ES/content/codespaces/troubleshooting/index.md index 2aeca351ebd3..cabc8b2247c8 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/index.md +++ b/translations/es-ES/content/codespaces/troubleshooting/index.md @@ -19,6 +19,7 @@ children: - /troubleshooting-dotfiles-for-codespaces - /troubleshooting-port-forwarding-for-github-codespaces - /troubleshooting-github-codespaces-clients + - /troubleshooting-gpg-verification-for-github-codespaces - /working-with-support-for-github-codespaces --- diff --git a/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 7f68a7bb8873..fdfc96b3885c 100644 --- a/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1,6 +1,6 @@ --- title: Webhook events and payloads -intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.' +intro: 'Learn about when each webhook event occurs and what the payload contains.' product: '{% data reusables.gated-features.enterprise_account_webhooks %}' redirect_from: - /early-access/integrations/webhooks @@ -97,1568 +97,4 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. > } ``` -{% ifversion fpt or ghes > 3.3 or ghae or ghec %} -## branch_protection_rule - -Activity related to a branch protection rule. For more information, see "[About branch protection rules](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`rule` | `object` | The branch protection rule. Includes a `name` and all the [branch protection settings](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. -`changes` | `object` | If the action was `edited`, the changes to the rule. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.branch_protection_rule.edited }} -{% endif %} - -{% ifversion ghes > 3.3 %} -## cache_sync - -A Git ref has been successfully synced to a cache replica. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`cache_location` |`string` | The location of the cache server that has been updated. -`ref` | `string` | The ref that has been updated. -`before` | `string` | The OID of the ref on the cache replica before it was updated. -`after` | `string` | The OID of the ref on the cache replica after the update. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.cache_sync.synced }} -{% endif %} - -## check_run - -{% data reusables.webhooks.check_run_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `created` and `completed` event types in a repository -- Organization webhooks only receive payloads for the `created` and `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_run_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_run.created }} - -## check_suite - -{% data reusables.webhooks.check_suite_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `completed` event types in a repository -- Organization webhooks only receive payloads for the `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_suite_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_suite.completed }} - -## code_scanning_alert - -{% data reusables.webhooks.code_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.code_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `reopened_by_user` or `closed_by_user`, the `sender` object will be the user that triggered the event. The `sender` object is {% ifversion fpt or ghec %}`github`{% elsif ghes or ghae %}`github-enterprise`{% else %}empty{% endif %} for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.code_scanning_alert.reopened }} - -## commit_comment - -{% data reusables.webhooks.commit_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.commit_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.commit_comment.created }} - -{% ifversion ghes < 3.4 %} -## content_reference - -{% data reusables.webhooks.content_reference_short_desc %} - -Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" to create a new content attachment. - -### Availability - -- {% data variables.product.prodname_github_apps %} with the `content_references:write` permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.content_reference.created }} - -{% endif %} -## create - -{% data reusables.webhooks.create_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you create more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.create_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.create }} - -## delete - -{% data reusables.webhooks.delete_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you delete more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.delete_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.delete }} - -{% ifversion fpt or ghec %} -## dependabot_alert - -{% data reusables.webhooks.dependabot_alert_description %} - -### Availability - -{% data reusables.webhooks.dependabot_alert_availability %} - -### Webhook payload object - -{% data reusables.webhooks.dependabot_alert_payload %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.dependabot_alert.fixed }} -{% endif %} - -## deploy_key - -{% data reusables.webhooks.deploy_key_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.deploy_key_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deploy_key.created }} - -## deployment - -{% data reusables.webhooks.deployment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments). -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment }} - -## deployment_status - -{% data reusables.webhooks.deployment_status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment_status` |`object` | The [deployment status](/rest/reference/deployments#list-deployment-statuses). -`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`deployment_status["target_url"]` |`string` | The optional link added to the status. -`deployment_status["description"]`|`string` | The optional human-readable description added to the status. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments) that this status is associated with. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment_status }} - -{% ifversion fpt or ghec %} -## discussion - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a discussion. For more information, see the "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, `deleted`, `pinned`, `unpinned`, `locked`, `unlocked`, `transferred`, `category_changed`, `answered`, `unanswered`, `labeled`, or `unlabeled`. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion.created }} - -## discussion_comment - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a comment in a discussion. For more information, see "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`comment` | `object` | The [`discussion comment`](/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion_comment.created }} -{% endif %} - -{% ifversion ghes or ghae %} - -## enterprise - -{% data reusables.webhooks.enterprise_short_desc %} - -### Availability - -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `anonymous_access_enabled` or `anonymous_access_disabled`. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.enterprise.anonymous_access_enabled }} - -{% endif %} - -## fork - -{% data reusables.webhooks.fork_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.fork_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.fork }} - -## github_app_authorization - -When someone revokes their authorization of a {% data variables.product.prodname_github_app %}, this event occurs. A {% data variables.product.prodname_github_app %} receives this webhook by default and cannot unsubscribe from this event. - -{% data reusables.webhooks.authorization_event %} For details about user-to-server requests, which require {% data variables.product.prodname_github_app %} authorization, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `revoked`. -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.github_app_authorization.revoked }} - -## gollum - -{% data reusables.webhooks.gollum_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.gollum_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.gollum }} - -## installation - -{% data reusables.webhooks.installation_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation.deleted }} - -## installation_repositories - -{% data reusables.webhooks.installation_repositories_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_repositories_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation_repositories.added }} - -## issue_comment - -{% data reusables.webhooks.issue_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_comment_webhook_properties %} -{% data reusables.webhooks.issue_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.issue_comment.created }} - -## issues - -{% data reusables.webhooks.issues_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_webhook_properties %} -{% data reusables.webhooks.issue_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone edits an issue - -{{ webhookPayloadsForCurrentVersion.issues.edited }} - -## label - -{% data reusables.webhooks.label_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Can be `created`, `edited`, or `deleted`. -`label`|`object` | The label that was added. -`changes`|`object`| The changes to the label if the action was `edited`. -`changes[name][from]`|`string` | The previous version of the name if the action was `edited`. -`changes[color][from]`|`string` | The previous version of the color if the action was `edited`. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.label.deleted }} - -{% ifversion fpt or ghec %} -## marketplace_purchase - -Activity related to a GitHub Marketplace purchase. {% data reusables.webhooks.action_type_desc %} For more information, see the "[GitHub Marketplace](/marketplace/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` | `string` | The action performed for a [GitHub Marketplace](https://github.com/marketplace) plan. Can be one of:
  • `purchased` - Someone purchased a GitHub Marketplace plan. The change should take effect on the account immediately.
  • `pending_change` - You will receive the `pending_change` event when someone has downgraded or cancelled a GitHub Marketplace plan to indicate a change will occur on the account. The new plan or cancellation takes effect at the end of the billing cycle. The `cancelled` or `changed` event type will be sent when the billing cycle has ended and the cancellation or new plan should take effect.
  • `pending_change_cancelled` - Someone has cancelled a pending change. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.
  • `changed` - Someone has upgraded or downgraded a GitHub Marketplace plan and the change should take effect on the account immediately.
  • `cancelled` - Someone cancelled a GitHub Marketplace plan and the last billing cycle has ended. The change should take effect on the account immediately.
- -For a detailed description of this payload and the payload for each type of `action`, see [{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/). - -### Webhook payload example when someone purchases the plan - -{{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }} - -{% endif %} - -## member - -{% data reusables.webhooks.member_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.member_webhook_properties %} -{% data reusables.webhooks.member_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.member.added }} - -## membership - -{% data reusables.webhooks.membership_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.membership_properties %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.membership.removed }} - -{% ifversion fpt or ghec %} - -## merge_group - -{% data reusables.pull_requests.merge-queue-beta %} - -Activity related to merge groups in a merge queue. The type of activity is specified in the action property of the payload object. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Merge queues** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Currently, can only be `checks_requested`. -`merge_group`|`object` | The merge group. -`merge_group[head_sha]`|`string` | The SHA of the merge group. -`merge_group[head_ref]`|`string` | The full ref of the merge group. -`merge_group[base_sha]`|`string` | The SHA of the merge group's parent commit. -`merge_group[base_ref]`|`string` | The full ref of the branch the merge group will be merged into. -`merge_group[head_commit]`|`object` | An expanded representation of the `head_sha` commit. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.merge_group.checks_requested }} - -{% endif %} - -## meta - -The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `deleted`. -`hook_id` |`integer` | The id of the modified webhook. -`hook` |`object` | The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.meta.deleted }} - -## milestone - -{% data reusables.webhooks.milestone_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.milestone_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.milestone.created }} - -## organization - -{% data reusables.webhooks.organization_short_desc %} - -### Availability - -{% ifversion ghes or ghae %} -- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} -- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of:{% ifversion ghes or ghae %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`. -`invitation` |`object` | The invitation for the user or email if the action is `member_invited`. -`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.organization.member_added }} - -{% ifversion fpt or ghec %} - -## org_block - -{% data reusables.webhooks.org_block_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`action` | `string` | The action performed. Can be `blocked` or `unblocked`. -`blocked_user` | `object` | Information about the user that was blocked or unblocked. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.org_block.blocked }} - -{% endif %} - -## package - -Activity related to {% data variables.product.prodname_registry %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[Managing packages with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages)" to learn more about {% data variables.product.prodname_registry %}. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.package_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.package.published }} - -## page_build - -{% data reusables.webhooks.page_build_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pages** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`id` | `integer` | The unique identifier of the page build. -`build` | `object` | The [List GitHub Pages builds](/rest/reference/pages#list-github-pages-builds) itself. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.page_build }} - -## ping - -{% data reusables.webhooks.ping_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} receive a ping event with an `app_id` used to register the app - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`zen` | `string` | Random string of GitHub zen. -`hook_id` | `integer` | The ID of the webhook that triggered the ping. -`hook` | `object` | The [webhook configuration](/rest/reference/webhooks#get-a-repository-webhook). -`hook[app_id]` | `integer` | When you register a new {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/) an app. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.ping }} - -## project - -{% data reusables.webhooks.project_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project.created }} - -## project_card - -{% data reusables.webhooks.project_card_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_card_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_card.created }} - -## project_column - -{% data reusables.webhooks.project_column_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_column_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_column.created }} - -{% ifversion project-beta-webhooks %} - -## projects_v2_item - -{% note %} - -**Note:** Webhook events for {% data variables.projects.projects_v2 %} are currently in beta and subject to change. To share feedback about {% data variables.projects.projects_v2 %} webhooks with {% data variables.product.product_name %}, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - -{% endnote %} - -Activity related to items in a {% data variables.projects.project_v2 %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[About {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed on the project item. Can be one of `archived`, `converted`, `created`, `edited`, `restored`, `deleted`, or `reordered`. -`projects_v2_item`|`object` | The project item itself. To find more information about the project item, you can use `node_id` (the node ID of the project item) and `project_node_id` (the node ID of the project) to query information in the GraphQL API. For more information, see "[Using the API to manage projects](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." -`changes`|`object` | The changes to the project item. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.projects_v2_item.created }} - -{% endif %} - -## public - -{% data reusables.webhooks.public_short_desc %} -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.public }} - -## pull_request - -{% data reusables.webhooks.pull_request_short_desc %} - -{% ifversion fpt or ghec %} - {% data reusables.pull_requests.merge-queue-beta %} -{% endif %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_webhook_properties %} -{% data reusables.webhooks.pull_request_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -Deliveries for `review_requested` and `review_request_removed` events will have an additional field called `requested_reviewer`. - -{{ webhookPayloadsForCurrentVersion.pull_request.opened }} - -## pull_request_review - -{% data reusables.webhooks.pull_request_review_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review.submitted }} - -## pull_request_review_comment - -{% data reusables.webhooks.pull_request_review_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_comment_webhook_properties %} -{% data reusables.webhooks.pull_request_review_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} - -## pull_request_review_thread - -{% data reusables.webhooks.pull_request_review_thread_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_thread_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }} - -## push - -{% data reusables.webhooks.push_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you push more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`ref`|`string` | The full [`git ref`](/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. -`before`|`string` | The SHA of the most recent commit on `ref` before the push. -`after`|`string` | The SHA of the most recent commit on `ref` after the push. -`created`|`boolean` | Whether this push created the `ref`. -`deleted`|`boolean` | Whether this push deleted the `ref`. -`forced`|`boolean` | Whether this push was a force push of the `ref`. -`head_commit`|`object` | For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag. -`compare`|`string` | 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. -`commits`|`array` | 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.) -`commits[][id]`|`string` | The SHA of the commit. -`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit. -`commits[][message]`|`string` | The commit message. -`commits[][author]`|`object` | The git author of the commit. -`commits[][author][name]`|`string` | The git author's name. -`commits[][author][email]`|`string` | The git author's email address. -`commits[][url]`|`url` | URL that points to the commit API resource. -`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before. -`commits[][added]`|`array` | An array of files added in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were added. -`commits[][modified]`|`array` | An array of files modified by the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were modified. -`commits[][removed]`|`array` | An array of files removed in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were removed. -`pusher` | `object` | The user who pushed the commits. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.push }} - -## release - -{% data reusables.webhooks.release_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.release_webhook_properties %} -{% data reusables.webhooks.release_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.release.published }} - -## repository_dispatch - -This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)" endpoint. - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_dispatch }} - -## repository - -{% data reusables.webhooks.repository_short_desc %} - -### Availability - -- Repository webhooks receive all event types except `deleted` -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted` - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. This can be one of:
  • `created` - A repository is created.
  • `deleted` - A repository is deleted.
  • `archived` - A repository is archived.
  • `unarchived` - A repository is unarchived.
    • {% ifversion ghes or ghae %}
  • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
    • {% endif %}
  • `edited` - A repository's information is edited.
  • `renamed` - A repository is renamed.
  • `transferred` - A repository is transferred.
  • `publicized` - A repository is made public.
  • `privatized` - A repository is made private.
-{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository.publicized }} - -{% ifversion fpt or ghec %} -## repository_import - -{% data reusables.webhooks.repository_import_short_desc %} To receive this event for a personal repository, you must create an empty repository prior to the import. This event can be triggered using either the [GitHub Importer](/articles/importing-a-repository-with-github-importer/) or the [Source imports API](/rest/reference/migrations#source-imports). - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_import_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_import }} - -## repository_vulnerability_alert - -{% data reusables.webhooks.repository_vulnerability_alert_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_vulnerability_alert_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_vulnerability_alert.create }} - -{% endif %} - -{% ifversion ghes or ghec %} - -## secret_scanning_alert - -{% data reusables.webhooks.secret_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `resolved` or `reopened`, the `sender` object will be the user that triggered the event. The `sender` object is empty for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} -{% endif %} - -{% ifversion ghes > 3.4 or ghec or ghae > 3.4 %} -## secret_scanning_alert_location - -{% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_location_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert_location.created }} -{% endif %} - -{% ifversion fpt or ghes or ghec %} -## security_advisory - -Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}. - -The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. The action can be one of `published`, `updated`, `performed`, or `withdrawn` for all new events. -`security_advisory` |`object` | The details of the security advisory, including summary, description, and severity. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_advisory.published }} - -{% endif %} - -{% ifversion ghas-enablement-webhook %} - -## security_and_analysis - -Activity related to enabling or disabling code security and analysis features for a repository or organization. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`changes`|`object` | The changes that were made to the code security and analysis features. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_and_analysis }} - -{% endif %} - -{% ifversion fpt or ghec %} -## sponsorship - -{% data reusables.webhooks.sponsorship_short_desc %} - -You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". - -### Availability - -- Sponsored accounts - -### Webhook payload object - -{% data reusables.webhooks.sponsorship_webhook_properties %} -{% data reusables.webhooks.sponsorship_properties %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone creates a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.created }} - -### Webhook payload example when someone downgrades a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.downgraded }} - -{% endif %} - -## star - -{% data reusables.webhooks.star_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.star_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.star.created }} - -## status - -{% data reusables.webhooks.status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`id` | `integer` | The unique identifier of the status. -`sha`|`string` | The Commit SHA. -`state`|`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`description`|`string` | The optional human-readable description added to the status. -`target_url`|`string` | The optional link added to the status. -`branches`|`array` | An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.status }} - -## team - -{% data reusables.webhooks.team_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of `created`, `deleted`, `edited`, `added_to_repository`, or `removed_from_repository`. -`team` |`object` | The team itself. -`changes`|`object` | The changes to the team if the action was `edited`. -`changes[description][from]` |`string` | The previous version of the description if the action was `edited`. -`changes[name][from]` |`string` | The previous version of the name if the action was `edited`. -`changes[privacy][from]` |`string` | The previous version of the team's privacy if the action was `edited`. -`changes[repository][permissions][from][admin]` | `boolean` | The previous version of the team member's `admin` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][pull]` | `boolean` | The previous version of the team member's `pull` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][push]` | `boolean` | The previous version of the team member's `push` permission on a repository, if the action was `edited`. -`repository`|`object` | The repository that was added or removed from to the team's purview if the action was `added_to_repository`, `removed_from_repository`, or `edited`. For `edited` actions, `repository` also contains the team's new permission levels for the repository. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team.added_to_repository }} - -## team_add - -{% data reusables.webhooks.team_add_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`team`|`object` | The [team](/rest/reference/teams) that was modified. **Note:** Older events may not include this in the payload. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team_add }} - -{% ifversion ghes or ghae %} - -## user - -When a user is `created` or `deleted`. - -### Availability -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.user.created }} - -{% endif %} - -## watch - -{% data reusables.webhooks.watch_short_desc %} - -The event’s actor is the [user](/rest/reference/users) who starred a repository, and the event’s repository is the [repository](/rest/reference/repos) that was starred. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -{% data reusables.webhooks.watch_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.watch.started }} - -{% ifversion fpt or ghes or ghec %} -## workflow_dispatch - -This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the "[Create a workflow dispatch event](/rest/reference/actions/#create-a-workflow-dispatch-event)" endpoint. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -| Key | Type | Description | -|-----|-----|-----| -| `inputs` | `object` | Inputs to the workflow. Each key represents the name of the input while its value represents the value of that input. | -{% data reusables.webhooks.org_desc %} -| `ref` | `string` | The branch or tag from which the workflow was run. | -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} -| `workflow` | `string` | Relative path to the workflow file which contains the workflow. | - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_dispatch }} -{% endif %} - -## workflow_job - -{% data reusables.webhooks.workflow_job_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- Enterprise webhooks - -### Webhook payload object - -{% data reusables.webhooks.workflow_job_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_job }} - -{% ifversion fpt or ghes or ghec %} -## workflow_run - -When a {% data variables.product.prodname_actions %} workflow run is requested or completed. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_run)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions - -### Webhook payload object - -{% data reusables.webhooks.workflow_run_properties %} -{% data reusables.webhooks.workflow_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_run }} -{% endif %} + diff --git a/translations/es-ES/content/get-started/index.md b/translations/es-ES/content/get-started/index.md index 66f856ad3294..127e91ac0604 100644 --- a/translations/es-ES/content/get-started/index.md +++ b/translations/es-ES/content/get-started/index.md @@ -62,11 +62,11 @@ children: - /using-git - /customizing-your-github-workflow - /privacy-on-github -ms.openlocfilehash: 4178e22c506d32b0736305936b56c4c1ff348357 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 7671e605fa3644c4690de6ed16bd9a255bb6b1f6 +ms.sourcegitcommit: 2ecb6ba7d01b2bc9a44ad74a5953b98413216051 ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147580699' +ms.lasthandoff: 11/15/2022 +ms.locfileid: '148165357' --- diff --git a/translations/es-ES/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md index 4649ce4af468..62e9a6540565 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Administrar la visualización de los nombres de los miembros en tu organización -intro: Puedes permitir que los miembros de tu organización vean un nombre de perfil del autor de un comentarios en los repositorios privados en la organización. +title: Managing the display of member names in your organization +intro: You can allow members of your organization to see a comment author's profile name in private repositories in the organization. product: '{% data reusables.gated-features.display-names %}' redirect_from: - /articles/managing-the-display-of-member-names-in-your-organization @@ -14,22 +14,20 @@ topics: - Organizations - Teams shortTitle: Manage display of member names -ms.openlocfilehash: 0a394b40689d95ea37906fef2ddc9b203e2041c3 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147409431' --- -Los propietarios de la organización pueden administrar la visualización de los nombres de los miembros en una organización. -![Nombre del perfil del autor del comentario que se muestra en un comentario](/assets/images/help/issues/commenter-full-name.png) +Organization owners can manage the display of member names in an organization. -Cada miembro de la organización elige su propio nombre de perfil en sus configuraciones. Para obtener más información, consulte "[Personalización del perfil](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#changing-your-profile-name)". +![Commenter's profile name displayed in comment](/assets/images/help/issues/commenter-full-name.png) -{% ifversion profile-name-enterprise-setting %} Si el propietario de la cuenta de empresa ha establecido una directiva en el nivel de empresa, es posible que no puedas configurar este valor para tu organización. Para obtener más información, consulta "[Aplicación de directivas de administración de repositorios en la empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)".{% endif %} +Changes to the display of usernames within an organization will affect the display of other people's usernames, not your own. Each organization member chooses their own profile name in their settings. For more information, see "[Personalizing your profile](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#changing-your-profile-name)." -{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. Dentro de "Admin repository permissions" (Permisos del administrador del repositorio), seleccione o quite la marca de selección de **Allow members to see comment author's profile name in private repositories** (Permitir que los miembros vean el nombre de perfil del autor del comentario en los repositorios privados). -![Casilla para permitir que los miembros vean el nombre completo del autor del comentario en los repositorios privados](/assets/images/help/organizations/allow-members-to-view-full-names.png) -6. Haga clic en **Save**(Guardar). +{% ifversion profile-name-enterprise-setting %} +You may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."{% endif %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.member-privileges %} +5. Under "Admin repository permissions", select or unselect **Allow members to see comment author's profile name in private repositories**. +![Checkbox to allow members to see comment author's full name in private repositories](/assets/images/help/organizations/allow-members-to-view-full-names.png) +6. Click **Save**. diff --git a/translations/es-ES/content/rest/codespaces/repository-secrets.md b/translations/es-ES/content/rest/codespaces/repository-secrets.md index 1eb9c2a72dec..c3501f829204 100644 --- a/translations/es-ES/content/rest/codespaces/repository-secrets.md +++ b/translations/es-ES/content/rest/codespaces/repository-secrets.md @@ -3,18 +3,19 @@ title: Secretos del repositorio de Codespaces allowTitleToDifferFromFilename: true shortTitle: Repository secrets intro: 'La API de secretos del repositorio de Codespaces permite que un usuario cree, enumere y elimine secretos (tales como los tokens de acceso para los servicios en la nube) para los repositorios a los que el usuario tenga acceso en un codespace.' +permissions: 'Users with write access to a repository can manage {% data variables.product.prodname_codespaces %} repository secrets.' versions: fpt: '*' ghec: '*' topics: - API miniTocMaxHeadingLevel: 3 -ms.openlocfilehash: d80d75934cc41db2ae12db2df47a41e74627dfef -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 95b3dfaafef598bf05f55d697716eb1036093697 +ms.sourcegitcommit: 9490533fcb7b7d5c16f8fea082a06ee66dd5db8f ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147063982' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148165605' --- ## Acerca de la API de secretos del repositorio de Codespaces diff --git a/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md b/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md index 8a22bc5d041c..8e2a67e942c7 100644 --- a/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md +++ b/translations/es-ES/data/reusables/actions/actions-audit-events-workflow.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: 1162ab428d4c20f7f0ca4af8c1ec743b30e42852 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 4f04b4395ec12d834bc4d8f350b302c09badea6d +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 10/25/2022 -ms.locfileid: "148109909" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163183" --- | Acción | Descripción |------------------|------------------- diff --git a/translations/es-ES/data/reusables/actions/minio-gateways-removal.md b/translations/es-ES/data/reusables/actions/minio-gateways-removal.md deleted file mode 100644 index af8bf12313f8..000000000000 --- a/translations/es-ES/data/reusables/actions/minio-gateways-removal.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -ms.openlocfilehash: b960c6a45b8d934a25c2d7d24e3961fb613ad3d4 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147061550" ---- -{% warning %} - -**Advertencia**: MinIO ha anunciado la eliminación de puertas de enlace de MinIO. A partir del 1 de junio de 2022, el soporte técnico y las correcciones de errores para la implementación actual de la puerta de enlace NAS de MinIO solo estarán disponibles para los clientes de pago a través de su contrato de soporte técnico LTS. Si quieres seguir usando puertas de enlace de MinIO con {% data variables.product.prodname_actions %}, se recomienda pasar a la compatibilidad con MinIO LTS. Para obtener más información, consulta [Eliminación programada de la puerta de enlace MinIO para GCS, Azure, HDFS](https://github.com/minio/minio/issues/14331) en el repositorio de minio/minio. - -{% endwarning %} diff --git a/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md b/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md index f5992daa0c7b..9aa9fe7fab8f 100644 --- a/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md +++ b/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: 596395b05b2e34b9793107674c8e14bf12d103c8 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 830540b45884edcec609f94aeeaaf5b661a95a51 +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 10/25/2022 -ms.locfileid: "148109840" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163215" --- | Acción | Descripción |--------|------------ diff --git a/translations/es-ES/data/reusables/dependabot/dependabot-tos.md b/translations/es-ES/data/reusables/dependabot/dependabot-tos.md index 35de871e9d5e..ecb35a83e52e 100644 --- a/translations/es-ES/data/reusables/dependabot/dependabot-tos.md +++ b/translations/es-ES/data/reusables/dependabot/dependabot-tos.md @@ -1,11 +1,11 @@ --- -ms.openlocfilehash: 30fe5aa7bd3853049757fded26fb3a257f2cd491 -ms.sourcegitcommit: 770ed406ec075528ec9c9695aa4bfdc8c8b25fd3 +ms.openlocfilehash: e71674bb25f77d71366fdc2c3b8ed56d55c81657 +ms.sourcegitcommit: aa67bb5ad7aa6804c5def4390e30adcc7cf96ea1 ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 09/11/2022 -ms.locfileid: "147884855" +ms.lasthandoff: 11/15/2022 +ms.locfileid: "148165205" --- {% ifversion fpt %} {% data variables.product.prodname_dependabot %} y todas las características relacionadas están sujetas por los [Términos del servicio de {% data variables.product.prodname_dotcom %}](/free-pro-team@latest/github/site-policy/github-terms-of-service). -El acuerdo de licencia abarca {% elsif ghec %} {% data variables.product.prodname_dependabot %} y todas las características relacionadas. Para más información, vea "[Términos del cliente empresarial de {% data variables.product.company_short %}](https://github.com/enterprise-legal)". +El acuerdo de licencia abarca {% elsif ghec %} {% data variables.product.prodname_dependabot %} y todas las características relacionadas. Para más información, vea "[Términos del cliente empresarial de {% data variables.product.company_short %}](https://github.com/customer-terms)". {% endif %} diff --git a/translations/es-ES/data/reusables/organizations/types-of-team-visibility.md b/translations/es-ES/data/reusables/organizations/types-of-team-visibility.md index 28187efa4d9e..1c3d33376999 100644 --- a/translations/es-ES/data/reusables/organizations/types-of-team-visibility.md +++ b/translations/es-ES/data/reusables/organizations/types-of-team-visibility.md @@ -1,12 +1,14 @@ --- -ms.openlocfilehash: 4382f549f709e0ecdeb5a578cbfa8bd05bab4ce8 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 6d6a0678050364e945321a4b9eaf8a06cb731554 +ms.sourcegitcommit: 1671bc6dbc112c6f8db987a6aa706612d464e68e ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: "145122138" +ms.lasthandoff: 11/11/2022 +ms.locfileid: "148163019" --- Los equipos pueden ser visibles o secretos: - Todos los miembros de la organización pueden [ver y @mentioned](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) los equipos visibles. - Solo las personas en el equipo y aquellas con permisos de propietario pueden ver los equipos secretos. Son ideales para ocultar equipos con nombres o miembros sensibles, tales como aquellos que se utilizan para trabajar con socios o clientes externos. Los equipos secretos no pueden anidarse bajo equipos padre ni tener equipos hijo. + +Las personas que no son miembros de la organización no pueden ver ningún equipo. diff --git a/translations/es-ES/data/reusables/projects/migrate-project-steps.md b/translations/es-ES/data/reusables/projects/migrate-project-steps.md index a9d014ae330d..560b66888c05 100644 --- a/translations/es-ES/data/reusables/projects/migrate-project-steps.md +++ b/translations/es-ES/data/reusables/projects/migrate-project-steps.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: ca36d1cc452ae102d0e4183b6d72ce854de57963 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 06ccb7d54079b9cd73a4ce66b02ae3cc9a7b3cf1 +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147423200" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163233" --- 1. Junto al proyecto que quieres migrar, haz clic en {% octicon "kebab-horizontal" aria-label="The menu icon" %} para abrir el menú. 1. En el menú, haz clic en **Migrar**. diff --git a/translations/es-ES/data/reusables/support/data-protection-and-privacy.md b/translations/es-ES/data/reusables/support/data-protection-and-privacy.md index 504d88adcad0..5c57704e533c 100644 --- a/translations/es-ES/data/reusables/support/data-protection-and-privacy.md +++ b/translations/es-ES/data/reusables/support/data-protection-and-privacy.md @@ -1,11 +1,9 @@ --- -ms.openlocfilehash: f233439ae4430b7a7dd0fe3b2c4da87b60f2ab28 -ms.sourcegitcommit: 80842b4e4c500daa051eff0ccd7cde91c2d4bb36 +ms.openlocfilehash: c4ab6a9deea7bf6596f968de26f996392e3d689a +ms.sourcegitcommit: 2ecb6ba7d01b2bc9a44ad74a5953b98413216051 ms.translationtype: HT ms.contentlocale: es-ES -ms.lasthandoff: 09/12/2022 -ms.locfileid: "145069308" +ms.lasthandoff: 11/15/2022 +ms.locfileid: "148165365" --- -Al usar las ofertas de soporte técnico de {% data variables.product.prodname_dotcom %}, se aplican los términos del Acuerdo, la [Declaración de privacidad de GitHub](/free-pro-team@latest/github/site-policy/github-privacy-statement) y el [Acuerdo de protección de datos GitHub](/free-pro-team@latest/github/site-policy/github-data-protection-agreement). Por Acuerdo, significa su contrato principal con nosotros, es decir, los [Términos de servicio corporativos de GitHub](/free-pro-team@latest/github/site-policy/github-corporate-terms-of-service), el [Acuerdo de cliente de GitHub](https://github.com/enterprise-legal) o el [Acuerdo de licencias por volumen de Microsoft](/free-pro-team@latest/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing). - - +Al usar las ofertas de soporte técnico de {% data variables.product.prodname_dotcom %}, se aplican los términos del Acuerdo, la [Declaración de privacidad de GitHub](/free-pro-team@latest/github/site-policy/github-privacy-statement) y el [Acuerdo de protección de datos GitHub](/free-pro-team@latest/github/site-policy/github-data-protection-agreement). Por Acuerdo, significa su contrato principal con nosotros, es decir, los [Términos de servicio corporativos de GitHub](/free-pro-team@latest/github/site-policy/github-corporate-terms-of-service), el [Acuerdo de cliente de GitHub](https://github.com/customer-terms) o el [Acuerdo de licencias por volumen de Microsoft](/free-pro-team@latest/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing). diff --git a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md index 7186ebf26592..2adee6a3f4e1 100644 --- a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md +++ b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md @@ -180,24 +180,35 @@ jobs: ``` {% endraw %} +## Calling a reusable workflow + +You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. + +[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) + +You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} + +{% data reusables.actions.reusable-workflow-calling-syntax %} + +You can call multiple workflows, referencing each in a separate job. + +{% data reusables.actions.uses-keyword-example %} + +### Passing inputs and secrets to a reusable workflow + +{% data reusables.actions.pass-inputs-to-reusable-workflows%} + {% ifversion actions-reusable-workflow-matrix %} -## Using a matrix strategy with a reusable workflow +### Using a matrix strategy with a reusable workflow Jobs using the matrix strategy can call a reusable workflow. A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. For example, you can use a matrix strategy to pass different inputs to a reusable workflow. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)." -### Example matrix strategy with a reusable workflow - -This workflow file references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. The workflow will run three jobs, one for each value in the variable. The workflow file also calls a reusable workflow by using the `uses` keyword. +This example job below calls a reusable workflow and references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. It will run three jobs, one for each value in the variable. {% raw %} ```yaml{:copy} -name: Reusable workflow with matrix strategy - -on: - push: - jobs: ReuseableMatrixJobForDeployment: strategy: @@ -208,25 +219,7 @@ jobs: target: ${{ matrix.target }} ``` {% endraw %} - {% endif %} -## Calling a reusable workflow - -You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. - -[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) - -You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} - -{% data reusables.actions.reusable-workflow-calling-syntax %} - -You can call multiple workflows, referencing each in a separate job. - -{% data reusables.actions.uses-keyword-example %} - -### Passing inputs and secrets to a reusable workflow - -{% data reusables.actions.pass-inputs-to-reusable-workflows%} ### Supported keywords for jobs that call a reusable workflow @@ -238,7 +231,12 @@ When you call a reusable workflow, you can only use the following keywords in th * [`jobs..with.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id) * [`jobs..secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets) * [`jobs..secrets.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id) - {% ifversion actions-inherit-secrets-reusable-workflows %}* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %} +{%- ifversion actions-inherit-secrets-reusable-workflows %} +* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit) +{%- endif %} +{%- ifversion actions-reusable-workflow-matrix %} +* [`jobs..strategy`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategy) +{%- endif %} * [`jobs..needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds) * [`jobs..if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) * [`jobs..permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions) diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index 5b582d063045..e4f70c36cb33 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -33,15 +33,13 @@ During initialization, the enterprise owner will name your enterprise, configure To begin initialization, you will receive an invitation email from {% data variables.product.company_short %}. Before you configure {% data variables.product.prodname_ghe_managed %}, review the following prerequisites. -1. To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." +To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." - {% note %} - - **Note**: {% data reusables.saml.create-a-machine-user %} +{% note %} - {% endnote %} +**Note**: {% data reusables.saml.create-a-machine-user %} -2. {% data reusables.saml.assert-the-administrator-attribute %} +{% endnote %} ## Signing in and naming your enterprise @@ -66,6 +64,7 @@ To configure authentication for {% data variables.product.product_name %}, you m !["Test SAML configuration" button](/assets/images/enterprise/configuration/ae-test-saml-configuration.png) 1. Click **Save**. !["Save" button for IdP configuration](/assets/images/enterprise/configuration/ae-save.png) +1. {% data reusables.saml.assert-the-administrator-attribute %} ## Setting your enterprise policies diff --git a/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md b/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md index bc4c56280426..b5b33bf5dd1b 100644 --- a/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md +++ b/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md @@ -11,12 +11,12 @@ type: overview topics: - Clustering - Enterprise -ms.openlocfilehash: c0f442f455bffea9fd6e7bd225d7c37c0820b4ab -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d +ms.openlocfilehash: 6c009e5d5aa1c2f0b2d3effb3beab2d51f48b070 +ms.sourcegitcommit: ced661bdffebd0f96f6f76db109fbe31983448ba ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145112782' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148167074' --- {% data reusables.enterprise_clustering.clustering-requires-https %} @@ -56,7 +56,7 @@ ms.locfileid: '145112782' - Organization にとって意味のあるノードの層を確立します。 設定例: - 2つのノードと以下のサービスを持つフロントエンド層： - `web-server` - - `jobs-server` + - `job-server` - `memcache-server` - 3つのノードと以下のサービスを持つデータベース層： - `consul-server` diff --git a/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md b/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md index 7de7280aa142..d9f9b98dbcbf 100644 --- a/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md +++ b/translations/ja-JP/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md @@ -1,6 +1,6 @@ --- -title: クラスタの初期化 -intro: '{% data variables.product.prodname_ghe_server %} クラスタはライセンスを使用して設定し、管理シェル (SSH) を使用して初期化する必要があります。' +title: Initializing the cluster +intro: 'A {% data variables.product.prodname_ghe_server %} cluster must be set up with a license and initialized using the administrative shell (SSH).' redirect_from: - /enterprise/admin/clustering/initializing-the-cluster - /enterprise/admin/enterprise-management/initializing-the-cluster @@ -11,111 +11,151 @@ type: how_to topics: - Clustering - Enterprise -ms.openlocfilehash: ea771194e8bf5104707a645c4ee18473ff235153 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146331817' --- {% data reusables.enterprise_clustering.clustering-requires-https %} -## {% data variables.product.prodname_ghe_server %}のインストール +## Installing {% data variables.product.prodname_ghe_server %} -1. 各クラスタノードで {% data variables.product.prodname_ghe_server %} をプロビジョニングしてインストールします。 詳細については、「[{% data variables.product.prodname_ghe_server %} インスタンスをセットアップする](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)」を参照してください。 -2. 管理シェルまたは DHCP を使用し、各ノードの IP アドレス **のみ** を構成します。 その他の設定は行わないでください。 +1. On each cluster node, provision and install {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." +2. Using the administrative shell or DHCP, **only** configure the IP address of each node. Don't configure any other settings. -## 最初のノードの設定 +## Configuring the first node -1. `cluster.conf` で MySQL プライマリとして指定されるノードに接続します。 詳しくは、「[クラスター構成ファイルについて](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)」を参照してください。 -2. Web ブラウザーで `https://:8443/setup/` に移動します。 -{% data reusables.enterprise_installation.upload-a-license-file %} {% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} {% data reusables.enterprise_installation.instance-will-restart-automatically %} +1. Connect to the node that will be designated as MySQL primary in `cluster.conf`. For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)." +2. In your web browser, visit `https://:8443/setup/`. +{% data reusables.enterprise_installation.upload-a-license-file %} +{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} +{% data reusables.enterprise_installation.instance-will-restart-automatically %} -## クラスタの初期化 +## Initializing the cluster -クラスターを初期化するためには、クラスター設定ファイル (`cluster.conf`) が必要です。 詳しくは、「[クラスター構成ファイルについて](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)」を参照してください。 +To initialize the cluster, you need a cluster configuration file (`cluster.conf`). For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -1. 構成された最初のノードから `ghe-cluster-config-init` を実行します。 実行すると、クラスタ設定ファイルに設定されていないノードがある場合にクラスタを初期化します。 -2. `ghe-cluster-config-apply` を実行する。 これにより、`cluster.conf` ファイルを検証して各ノードファイルに設定を適用し、各ノードで設定されたサービスを起動します。 +1. From the first node that was configured, run `ghe-cluster-config-init`. This will initialize the cluster if there are nodes in the cluster configuration file that are not configured. +2. Run `ghe-cluster-config-apply`. This will validate the `cluster.conf` file, apply the configuration to each node file and bring up the configured services on each node. -実行中のクラスターの状態を確認するには、`ghe-cluster-status` コマンドを使います。 +To check the status of a running cluster use the `ghe-cluster-status` command. -## クラスタ設定ファイルについて +## About the cluster configuration file -クラスタ設定ファイル (`cluster.conf`) は、クラスター中のノードと、その上で動作するサービスを定義します。 -詳しくは、「[クラスター ノードについて](/enterprise/admin/guides/clustering/about-cluster-nodes)」を参照してください。 +The cluster configuration file (`cluster.conf`) defines the nodes in the cluster, and what services they run. +For more information, see "[About cluster nodes](/enterprise/admin/guides/clustering/about-cluster-nodes)." -この例 `cluster.conf` では、5 つのノードでクラスターを定義します。 +This example `cluster.conf` defines a cluster with 11 nodes. - - 2 つのノード (`ghe-app-node-\*` と呼ばれる) によって、クライアント要求に応答する `web-server` サービスと `job-server` サービスが実行されます。 - - 3 つのノード (`ghe-data-node-\*` と呼ばれる) は、{% data variables.product.prodname_ghe_server %} データの保存と取得のサービスを実行します。 + - Two nodes called `ghes-front-end-node-\*` run services responsible for responding to client requests. + - Three nodes called `ghes-database-node-\*` run services responsible for storage, retrieval, and replication of database data. + - Three nodes called `ghes-search-node-\*` run services responsible for search functionality. + - Three nodes called `ghes-storage-node-\*` run services responsible for storage, retrieval, and replication of data. -ノードの名前には、ホスト名として有効な任意の名前を選択できます。 この名前は各ノードのホスト名として設定され、各ノードの `/etc/hosts` に追加され、各ノードがローカルでお互いを解決できるようにします。 +The names of the nodes can be any valid hostname you choose. The names are set as the hostname of each node, and will also be added to `/etc/hosts` on each node, so that the nodes are locally resolvable to each other. -`mysql-server` と `mysql-master` 経由で MySQL プライマリとして構成した最初のクラスター ノードを指定します。 +Specify the first cluster node you configured as the MySQL primary via `mysql-server` and `mysql-master`. ```ini [cluster] - mysql-master = ghe-data-node-1 - redis-master = ghe-data-node-1 - primary-datacenter = default -[cluster "ghe-app-node-1"] - hostname = ghe-app-node-1 + mysql-master = ghes-database-node-1 + redis-master = ghes-database-node-1 + primary-datacenter = primary +[cluster "ghes-front-end-node-1"] + hostname = ghes-front-end-node-1 ipv4 = 192.168.0.2 # ipv6 = fd12:3456:789a:1::2 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-app-node-2"] - hostname = ghe-app-node-2 + memcache-server = true +[cluster "ghes-front-end-node-2"] + hostname = ghes-front-end-node-2 ipv4 = 192.168.0.3 # ipv6 = fd12:3456:789a:1::3 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-data-node-1"] - hostname = ghe-data-node-1 + memcache-server = true +[cluster "ghes-database-node-1"] + hostname = ghes-database-node-1 ipv4 = 192.168.0.4 # ipv6 = fd12:3456:789a:1::4 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-2"] - hostname = ghe-data-node-2 +[cluster "ghes-database-node-2"] + hostname = ghes-database-node-2 ipv4 = 192.168.0.5 # ipv6 = fd12:3456:789a:1::5 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-3"] - hostname = ghe-data-node-3 +[cluster "ghes-database-node-3"] + hostname = ghes-database-node-3 ipv4 = 192.168.0.6 # ipv6 = fd12:3456:789a:1::6 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true +[cluster "ghes-search-node-1"] + hostname = ghes-search-node-1 + ipv4 = 192.168.0.7 + # ipv6 = fd12:3456:789a:1::7 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-2"] + hostname = ghes-search-node-2 + ipv4 = 192.168.0.8 + # ipv6 = fd12:3456:789a:1::8 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-3"] + hostname = ghes-search-node-3 + ipv4 = 192.168.0.9 + # ipv6 = fd12:3456:789a:1::9 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-storage-node-1"] + hostname = ghes-storage-node-1 + ipv4 = 192.168.0.10 + # ipv6 = fd12:3456:789a:1::10 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true metrics-server = true +[cluster "ghes-storage-node-2"] + hostname = ghes-storage-node-2 + ipv4 = 192.168.0.11 + # ipv6 = fd12:3456:789a:1::11 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true storage-server = true + metrics-server = true +[cluster "ghes-storage-node-3"] + hostname = ghes-storage-node-3 + ipv4 = 192.168.0.12 + # ipv6 = fd12:3456:789a:1::12 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true + metrics-server = true ``` -構成された最初のノードでファイル `/data/user/common/cluster.conf` を作成します。 たとえば、`vim` を使用する場合は次のようになります。 +Create the file `/data/user/common/cluster.conf` on the configured first node. For example, using `vim`: ```shell ghe-data-node-1:~$ sudo vim /data/user/common/cluster.conf diff --git a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md deleted file mode 100644 index eef8b04347be..000000000000 --- a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: NAS ストレージ用の MinIO ゲートウェイで GitHub Actions を有効化する -intro: '{% data variables.product.prodname_ghe_server %} で {% data variables.product.prodname_actions %} を有効化し、NAS ストレージに MinIO Gateway を使用して、ワークフローの実行によって生成されたデータを保存できます。' -permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' -versions: - ghes: '*' -type: how_to -topics: - - Actions - - Enterprise - - Infrastructure - - Storage -redirect_from: - - /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage -shortTitle: MinIO Gateway for NAS storage -ms.openlocfilehash: bb738d04d54234704f3278422c1f1ef075956640 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148106870' ---- -{% data reusables.actions.minio-gateways-removal %} - -## 前提条件 - -{% data variables.product.prodname_actions %} を有効化する前に、次のステップを完了していることを確認してください。 - -* アプライアンスでのリソースの競合を回避するために、MinIO を {% data variables.location.product_location %} とは別にホストすることをお勧めします。 -* ワークフロー データを保存するためのバケットを作成します。 {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} - -{% data reusables.actions.enterprise-common-prereqs %} - -## NAS ストレージ用の MinIO ゲートウェイで {% data variables.product.prodname_actions %} を有効化する - -{% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. [Artifact & Log Storage]\(成果物とログ ストレージ\) の下で、 **[Amazon S3]** を選択し、ストレージ バケットの詳細を入力します。 - - * **[AWS Service URL]\(AWS サービス URL\)** : MinIO サービスの URL。 たとえば、`https://my-minio.example:9000` のようにします。 - * **[AWS S3 Bucket]\(AWS S3 バケット\)** : S3 バケットの名前。 - * **[AWS S3 Access Key]\(AWS S3 アクセス キー\)** および **[AWS S3 Secret Key]\(AWS S3 秘密鍵\)** : MinIO インスタンスで使用される `MINIO_ACCESS_KEY` および `MINIO_SECRET_KEY`。 - - ![Amazon S3 ストレージを選択するためのラジオボタンと MinIO 設定のフィールド](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) -1. [Artifact & Log Storage]\(成果物とログ ストレージ\) の下で、 **[Force path style]\(パス スタイルの強制\)** を選択します。 - - ![[パス スタイルの強制] のチェックボックス](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} - -{% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md index 3b7a7be889f3..560f5c4f68ff 100644 --- a/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md +++ b/translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md @@ -9,14 +9,14 @@ children: - /enabling-github-actions-with-azure-blob-storage - /enabling-github-actions-with-amazon-s3-storage - /enabling-github-actions-with-google-cloud-storage - - /enabling-github-actions-with-minio-gateway-for-nas-storage + - /enabling-github-actions-with-minio-storage - /managing-self-hosted-runners-for-dependabot-updates shortTitle: Enable GitHub Actions -ms.openlocfilehash: 273e03407dd8c3c0a125e2c215a973c88aaf884b -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 56512f06952512bec06068273f8df381a7ba4706 +ms.sourcegitcommit: 8f1801040a84ca9353899a2d1e6782c702aaed0d ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148109060' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148166546' --- diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index b4868411b1ce..6d81bf03fffc 100644 --- a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -131,7 +131,7 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {%- ifversion actions-ghes-gcp-storage %} * Google Cloud Storage {%- endif %} -* S3-compatible MinIO Gateway for NAS +* S3-compatible MinIO cluster {% note %} @@ -141,8 +141,6 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {% endnote %} -{% data reusables.actions.minio-gateways-removal %} - ## Networking considerations {% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." @@ -158,7 +156,7 @@ Follow one of the procedures below to enable {% data variables.product.prodname_ {%- ifversion actions-ghes-gcp-storage %} * [Enabling GitHub Actions with Google Cloud Storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage) {%- endif %} -* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage) +* [Enabling GitHub Actions with MinIO storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage) ## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index f24cbdcd6c0c..ceebd276ec9b 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -1,7 +1,7 @@ --- -title: Azure AD を使用して Enterprise の認証とプロビジョニングを設定する +title: Configuring authentication and provisioning for your enterprise using Azure AD shortTitle: Configure with Azure AD -intro: 'Azure Active Directory (Azure AD) のテナントを ID プロバイダー (IdP) として使って、{% data variables.location.product_location %} の認証とユーザー プロビジョニングを一元管理できます。' +intro: 'You can use a tenant in Azure Active Directory (Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.location.product_location %}.' permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.' versions: ghae: '*' @@ -17,67 +17,65 @@ redirect_from: - /admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad -ms.openlocfilehash: 10b6fdaa2014836e7a709bc94920dea6331ed030 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148107510' --- -## Azure AD を使用した認証とユーザプロビジョニングについて -Azure Active Directory (Azure AD) は、ユーザアカウントと Web アプリケーションへのアクセスを一元管理できる Microsoft のサービスです。 詳細については、Microsoft Docs の「[Azure Active Directory とは](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis)」を参照してください。 +## About authentication and user provisioning with Azure AD -{% data variables.product.product_name %} のアイデンティティとアクセスを管理するために、Azure AD テナントを認証用の SAML IdP として使用できます。 アカウントを自動的にプロビジョニングし、SCIM でメンバーシップにアクセスするように、Azure AD を構成することもできます。これにより、{% data variables.product.product_name %} のユーザーを作成し、Azure AD テナントから Team と Organization のメンバーシップを管理できます。 +Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs. + +To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access membership with SCIM, which allows you to create {% data variables.product.product_name %} users and manage team and organization membership from your Azure AD tenant. {% data reusables.scim.ghes-beta-note %} -Azure AD を使って {% data variables.product.product_name %} に対して SAML SSO と SCIM を有効にした後、Azure AD テナントから以下を実行できます。 +After you enable SAML SSO and SCIM for {% data variables.product.product_name %} using Azure AD, you can accomplish the following from your Azure AD tenant. -* Azure AD の {% data variables.product.product_name %} アプリケーションをユーザー アカウントに割り当て、{% data variables.product.product_name %} 上に対応するユーザー アカウントを自動的に作成して、アクセスを許可します。 -* Azure AD 上のユーザー アカウントへの {% data variables.product.product_name %} アプリケーションの割り当てを解除し、{% data variables.product.product_name %} の対応するユーザー アカウントを非アクティブ化します。 -* {% data variables.product.product_name %} アプリケーションを Azure AD の IdP グループに割り当てて、IdP グループのすべてのメンバーに対する {% data variables.product.product_name %} 上のユーザー アカウントを自動的に作成して、アクセスを許可します。 さらに、Team とその親 Organization に接続するために、{% data variables.product.product_name %} で IdP グループを利用できます。 -* IdP グループから {% data variables.product.product_name %} アプリケーションの割り当てを解除すると、その IdP グループを介してのみアクセスしていたすべての IdP ユーザーの {% data variables.product.product_name %} ユーザー アカウントが非アクティブ化され、親 Organization からユーザーが削除されます。 IdP グループは {% data variables.product.product_name %} のどの Team からも切断されます +* Assign the {% data variables.product.product_name %} application on Azure AD to a user account to automatically create and grant access to a corresponding user account on {% data variables.product.product_name %}. +* Unassign the {% data variables.product.product_name %} application to a user account on Azure AD to deactivate the corresponding user account on {% data variables.product.product_name %}. +* Assign the {% data variables.product.product_name %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.product_name %} for connection to a team and its parent organization. +* Unassign the {% data variables.product.product_name %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. -{% data variables.location.product_location %} での Enterprise の ID とアクセスの管理について詳しくは、「[Enterprise の ID とアクセスを管理する](/admin/authentication/managing-identity-and-access-for-your-enterprise)」をご覧ください。 IdP グループとのチームの同期の詳細については、「[チームを ID プロバイダー グループと同期する](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)」を参照してください。 +For more information about managing identity and access for your enterprise on {% data variables.location.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." -## 前提条件 +## Prerequisites -- Azure AD を使用して {% data variables.product.product_name %} の認証とユーザプロビジョニングを設定するには、Azure AD アカウントとテナントが必要です。 詳細については、[Azure AD Web サイト](https://azure.microsoft.com/free/active-directory)および Microsoft Docs の「[クイックスタート: Azure Active Directory テナントを作成する](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant)」を参照してください。 +- To configure authentication and user provisioning for {% data variables.product.product_name %} using Azure AD, you must have an Azure AD account and tenant. For more information, see the [Azure AD website](https://azure.microsoft.com/free/active-directory) and [Quickstart: Create an Azure Active Directory tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) in the Microsoft Docs. {%- ifversion scim-for-ghes %} -- {% data reusables.saml.ghes-you-must-configure-saml-sso %} {%- endif %} - -- {% data reusables.saml.assert-the-administrator-attribute %} Azure AD からの SAML 要求に `administrator` 属性を含める方法の詳細については、Microsoft Docs の「[エンタープライズ アプリケーションの SAML トークンで発行された要求のカスタマイズ](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization)」を参照してください。 +- {% data reusables.saml.ghes-you-must-configure-saml-sso %} +{%- endif %} - {% data reusables.saml.create-a-machine-user %} -## Azure AD を使用して認証とユーザプロビジョニングを設定する +## Configuring authentication and user provisioning with Azure AD -Azure AD テナントで、{% data variables.product.product_name %} 用のアプリケーションを追加してから、プロビジョニングを構成します。 +In your Azure AD tenant, add the application for {% data variables.product.product_name %}, then configure provisioning. {% ifversion ghae %} -1. Azure AD で、{% data variables.enterprise.ae_azure_ad_app_link %} をテナントに追加し、シングル サインオンを構成します。 詳しくは、Microsoft Docs の[チュートリアル: Azure Active Directory シングル サインオン (SSO) と {% data variables.product.product_name %} の統合](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial)に関する記事をご覧ください。 +1. In Azure AD, add the {% data variables.enterprise.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.product_name %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs. -1. {% data variables.product.product_name %} で、Azure AD テナントの詳細を入力します。 +1. In {% data variables.product.product_name %}, enter the details for your Azure AD tenant. - {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} - - 別の IdP を使って {% data variables.location.product_location %} の SAML SSO を既に設定しており、その代わりに Azure AD を使う場合は、構成を編集できます。 詳細については、「[エンタープライズ向けの SAML シングル サインオンの構成](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)」を参照してください。 + - If you've already configured SAML SSO for {% data variables.location.product_location %} using another IdP and you want to use Azure AD instead, you can edit your configuration. For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)." -1. {% data variables.product.product_name %} でユーザプロビジョニングを有効化し、Azure AD でユーザプロビジョニングを設定します。 詳細については、「[エンタープライズ向けのユーザー プロビジョニングの構成](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)」を参照してください。 +1. Enable user provisioning in {% data variables.product.product_name %} and configure user provisioning in Azure AD. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." {% elsif scim-for-ghes %} -1. Azure AD テナントの左側のサイドバーで、 **[プロビジョニング]** をクリックします。 +1. In the Azure AD tenant, in the left sidebar, click **Provisioning**. -1. [テナント URL] に、{% data variables.location.product_location %} での SCIM の完全なエンドポイント URL を入力します。 詳しくは、REST API のドキュメントの「[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)」をご覧ください。 +1. Under "Tenant URL", type the full endpoint URL for SCIM on {% data variables.location.product_location %}. For more information, see "[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)" in the REST API documentation. -1. [シークレット トークン] に、「[Enterprise 用の SCIM を使用したユーザーのプロビジョニングを構成する](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)」のステップ 4 で作成した {% data variables.product.pat_v1 %} を入力します。 +1. Under "Secret Token", type the {% data variables.product.pat_v1 %} that you created in step 4 of "[Configuring user provisioning with SCIM for your enterprise](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." -1. Azure AD から {% data variables.location.product_location %} への正常な接続を確認するには、 **[テスト接続]** をクリックします。 +1. To ensure a successful connection from Azure AD to {% data variables.location.product_location %}, Click **Test Connection**. -1. 接続が成功したことを確認したら、ページの上部にある **[保存]** をクリックします。 +1. After you ensure a successful connection, at the top of the page, click **Save**. {% endif %} + +1. Assign an enterprise owner for {% data variables.product.product_name %} in Azure AD. The process you should follow depends on whether you configured provisioning. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." + - If you configured provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, assign the enterprise owner role to the user in Azure AD. + - If you did not configure provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs. diff --git a/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index 443b6038e140..935cf07d9036 100644 --- a/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/translations/ja-JP/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -24,19 +24,10 @@ This quickstart shows you how to set up MinIO using Docker for use with {% data | MinIO mode | Optimized for | Storage infrastructure required | |----|----|----| | Standalone MinIO (on a single host) | Fast setup | N/A | -| MinIO as a NAS gateway | NAS (Network-attached storage)| NAS devices | | Clustered MinIO (also called Distributed MinIO)| Data security | Storage servers running in a cluster | For more information about your options, see the official [MinIO docs](https://docs.min.io/). -{% warning %} - -**Warning**: MinIO has announced removal of MinIO Gateways. Starting June 1st, 2022, support and bug fixes for the current MinIO NAS Gateway implementation will only be available for paid customers via their LTS support contract. If you want to continue using MinIO Gateways with {% data variables.product.prodname_registry %}, we recommend moving to MinIO LTS support. For more information, see [Scheduled removal of MinIO Gateway for GCS, Azure, HDFS](https://github.com/minio/minio/issues/14331) in the minio/minio repository. - -Other modes of MinIO remain available with standard support. - -{% endwarning %} - ## 2. Install, run, and sign in to MinIO 1. Set up your preferred environment variables for MinIO. @@ -93,18 +84,6 @@ Other modes of MinIO remain available with standard support. For more information, see "[MinIO Docker Quickstart guide](https://docs.min.io/docs/minio-docker-quickstart-guide.html)." - * Run MinIO using Docker as a NAS gateway: - - This setup is useful for deployments where there is already a NAS you want to use as the backup storage for {% data variables.product.prodname_registry %}. - - ```shell - $ docker run -p 9000:9000 \ - -v $MINIO_DIR:/data \ - -e "MINIO_ACCESS_KEY=$MINIO_ACCESS_KEY" \ - -e "MINIO_SECRET_KEY=$MINIO_SECRET_KEY" \ - minio/minio gateway nas /data - ``` - * Run MinIO using Docker as a cluster. This MinIO deployment uses several hosts and MinIO's erasure coding for the strongest data protection. To run MinIO in a cluster mode, see the "[Distributed MinIO Quickstart Guide](https://docs.min.io/docs/distributed-minio-quickstart-guide.html)." ## 3. Create your MinIO bucket for {% data variables.product.prodname_registry %} @@ -124,7 +103,7 @@ Other modes of MinIO remain available with standard support. $ docker run minio/mc BUCKET-NAME ``` - This example can be used for MinIO standalone or MinIO as a NAS gateway. + This example can be used for MinIO standalone. * Clustered deployments example: diff --git a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md index 5888c25b06a2..cf62edb6c3eb 100644 --- a/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md +++ b/translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md @@ -1,6 +1,6 @@ --- -title: アクティブな SAML セッションの表示と管理 -intro: セキュリティ設定でアクティブな SAML セッションを表示および削除することができます。 +title: Viewing and managing your active SAML sessions +intro: You can view and revoke your active SAML sessions in your settings. redirect_from: - /articles/viewing-and-managing-your-active-saml-sessions - /github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions @@ -9,28 +9,31 @@ versions: ghec: '*' topics: - SSO +type: how_to shortTitle: Active SAML sessions -ms.openlocfilehash: ee30f76143ec28a810cd23150d115a3b1cd213c8 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145120030' --- -{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security %} -3. [Sessions] で、アクティブな SAML セッションを確認できます。 - ![アクティブな SAML セッションのリスト](/assets/images/help/settings/saml-active-sessions.png) -4. セッションの詳細を表示するには、 **[詳細情報]** をクリックします。 - ![SAML セッションの詳細を開くボタン](/assets/images/help/settings/saml-expand-session-details.png) -5. セッションを取り消すには、 **[SAML の取り消し]** をクリックします。 - ![SAML セッションを取り消すボタン](/assets/images/help/settings/saml-revoke-session.png) + +You can view a list of devices that have logged into your account, and revoke any SAML sessions that you don't recognize. + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.sessions %} +1. Under "Web sessions," you can see your active SAML sessions. + + ![Screenshot of the list of active SAML sessions](/assets/images/help/settings/saml-active-sessions.png) + +1. To see the session details, click **See more**. + ![Screenshot of the active SAML sessions with the button to open SAML session details emphasized](/assets/images/help/settings/saml-expand-session-details.png) + +1. To revoke a session, click **Revoke SAML**. + + ![Screenshot of the Session details page with the button to revoke a SAML session emphasized](/assets/images/help/settings/saml-revoke-session.png) {% note %} - **注:** セッションを取り消すと、その Organization に対する SAML 認証が削除されます。 Organization に再びアクセスするには、アイデンティティプロバイダを介してシングルサインオンする必要があります。 詳細については、「[SAML SSO での認証について](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)」を参照してください。 + **Note:** When you revoke a session, you remove your SAML authentication to that organization. To access the organization again, you will need to single sign-on through your identity provider. For more information, see "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)." {% endnote %} -## 参考資料 +## Further reading -- 「[SAML SSO での認証について](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)」 +- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" diff --git a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/index.md b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/index.md index 3e202cd3272d..b2431aab3349 100644 --- a/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/index.md +++ b/translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/index.md @@ -32,6 +32,7 @@ children: - /githubs-ssh-key-fingerprints - /sudo-mode - /preventing-unauthorized-access + - /viewing-and-managing-your-sessions shortTitle: Account security --- diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index 12e391f7d357..da73ca9f01a0 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -1,7 +1,7 @@ --- -title: Running CodeQL code scanning in a container +title: コンテナで CodeQL Code scanningを実行する shortTitle: '{% data variables.product.prodname_code_scanning_capc %} in a container' -intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.' +intro: 'すべてのプロセスが同じコンテナで動作するようにすることで、{% data variables.product.prodname_code_scanning %} を実行できます。' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container @@ -21,42 +21,44 @@ topics: - Repositories - Containers - Java +ms.openlocfilehash: 60dac8a7f71af067c5cfaba5f48d123a3068f704 +ms.sourcegitcommit: aa488e9e641139f9056885b1479c8801e9906131 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148162808' --- - - {% data reusables.code-scanning.beta %} -## About {% data variables.product.prodname_code_scanning %} with a containerized build +## コンテナ化されたビルドで {% data variables.product.prodname_code_scanning %} を使用することについて -If you're setting up {% data variables.product.prodname_code_scanning %} for a compiled language, and you're building the code in a containerized environment, the analysis may fail with the error message "No source code was seen during the build." This indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code as it was compiled. +コンパイル言語用に {% data variables.product.prodname_code_scanning %} をセットアップし、コンテナ化された環境でコードをビルドしようとすると、解析が失敗し、"No source code was seen during the build." というエラーメッセージが出る場合があります。 これは、コードがコンパイルされているので {% data variables.product.prodname_codeql %} がコードをモニターできなかったことを示しています。 -You must run {% data variables.product.prodname_codeql %} inside the container in which you build your code. This applies whether you are using the {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, the {% data variables.code-scanning.codeql_runner %},{% endif %} or {% data variables.product.prodname_actions %}. For the {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}or the {% data variables.code-scanning.codeql_runner %}{% endif %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} or "[Running {% data variables.code-scanning.codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} for more information. If you're using {% data variables.product.prodname_actions %}, configure your workflow to run all the actions in the same container. For more information, see "[Example workflow](#example-workflow)." +{% data variables.product.prodname_codeql %}は、コードをビルドするコンテナ内で実行しなければなりません。 これは、{% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}、{% data variables.code-scanning.codeql_runner %}、{% endif %}または {% data variables.product.prodname_actions %} のいずれを使っていても当てはまります。 {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}または {% data variables.code-scanning.codeql_runner %}{% endif %}の場合、詳しくは、「[CI システムに {% data variables.product.prodname_codeql_cli %} をインストールする](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)」{% ifversion codeql-runner-supported %}または「[CI システムで {% data variables.code-scanning.codeql_runner %} を実行する](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)」{% endif %}をご覧ください。 {% data variables.product.prodname_actions %} を使用している場合は、同じコンテナですべてのアクションを実行するようワークフローを設定します。 詳しくは、「[ワークフローの例](#example-workflow)」をご覧ください。 {% note %} -**Note:** {% data reusables.code-scanning.non-glibc-linux-support %} +**メモ:** {% data reusables.code-scanning.non-glibc-linux-support %} {% endnote %} -## Dependencies +## 依存関係 -You may have difficulty running {% data variables.product.prodname_code_scanning %} if the container you're using is missing certain dependencies (for example, Git must be installed and added to the PATH variable). If you encounter dependency issues, review the list of software typically included on {% data variables.product.prodname_dotcom %}'s runner images. For more information, see the version-specific `readme` files in these locations: +使用しているコンテナで特定の依存関係がない場合 (たとえば、Git は PATH 変数にインストールされ、追加されている必要がある)、{% data variables.product.prodname_code_scanning %} を実行する上で困難が生じる場合があります。 依存関係の問題が生じた場合は、{% data variables.product.prodname_dotcom %} のランナー イメージに通常含まれているソフトウェアのリストを確認してください。 詳しくは、次の場所にある特定のバージョンの `readme` ファイルをご覧ください。 * Linux: https://github.com/actions/runner-images/tree/main/images/linux * macOS: https://github.com/actions/runner-images/tree/main/images/macos * Windows: https://github.com/actions/runner-images/tree/main/images/win -## Example workflow +## ワークフローの例 -{% ifversion ghes or ghae %} -{% note %} +{% ifversion ghes or ghae %} {% note %} -**Note:** This article describes the features available with the version of the CodeQL action and associated CodeQL CLI bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the CodeQL action, see the [{% data variables.product.prodname_ghe_cloud %} article](/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container) for information on the latest features.{% ifversion not ghae %} For information on using the latest version, see "[Configuring code scanning for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)."{% endif %} +**メモ:** この記事では、このバージョンの {% data variables.product.product_name %} の初期リリースに含まれる CodeQL アクションのバージョンおよび関連する CodeQL CLI バンドルで使用できる機能について説明します。 企業で CodeQL アクションのより新しいバージョンを使っている場合、最新機能について詳しくは、[{% data variables.product.prodname_ghe_cloud %} に関する記事](/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container)をご覧ください。{% ifversion not ghae %}最新バージョンの使用については、「[アプライアンスのコード スキャンの構成](/admin/advanced-security/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)」をご覧ください。{% endif %} -{% endnote %} -{% endif %} +{% endnote %} {% endif %} -This sample workflow uses {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_codeql %} analysis in a containerized environment. The value of `container.image` identifies the container to use. In this example the image is named `codeql-container`, with a tag of `f0f91db`. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)." +このサンプルワークフローでは、{% data variables.product.prodname_actions %} を使用して、コンテナ化された環境において {% data variables.product.prodname_codeql %} 解析を実行します。 使用するコンテナーを識別する `container.image` の値。 この例では、イメージは、`f0f91db` のタグを持つ、`codeql-container` という名前です。 詳細については、[{% data variables.product.prodname_actions %} のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)に関するページを参照してください。 ``` yaml name: "{% data variables.product.prodname_codeql %}" diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index ed98f29737a3..409056cacb8b 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -1,7 +1,7 @@ --- -title: SARIF support for code scanning +title: Code scanningの SARIF サポート shortTitle: SARIF support -intro: 'To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you''ll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically.' +intro: '{% data variables.product.prodname_dotcom %} のリポジトリにあるサードパーティの静的分析ツールからの結果を表示するには、{% data variables.product.prodname_code_scanning %} 用に SARIF 2.1.0 JSON スキーマの特定のサブセットをサポートする SARIF ファイルに結果を保存する必要があります。 デフォルトの {% data variables.product.prodname_codeql %} 静的分析エンジンを使用すると、結果は {% data variables.product.prodname_dotcom %} のリポジトリに自動的に表示されます。' product: '{% data reusables.gated-features.code-scanning %}' miniTocMaxHeadingLevel: 3 redirect_from: @@ -20,70 +20,74 @@ topics: - Code scanning - Integration - SARIF +ms.openlocfilehash: 98d0e4620d240c3e1863aaee6f57a5834c86018b +ms.sourcegitcommit: aa488e9e641139f9056885b1479c8801e9906131 +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148162792' --- - - {% data reusables.code-scanning.beta %} -## About SARIF support +## SARIF サポートについて -SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_capc %} supports a subset of the SARIF 2.1.0 JSON schema. +SARIF (Static Analysis Results Interchange Format) は、出力ファイル形式を定義する [OASIS 標準](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html)です。 SARIF 標準は、静的分析ツールが結果を共有する方法を合理化するために使用されます。 {% data variables.product.prodname_code_scanning_capc %} は、SARIF 2.1.0 JSON スキーマのサブセットをサポートしています。 -To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json). +サードパーティの静的コード分析エンジンから SARIF ファイルをアップロードするには、アップロードされたファイルが SARIF 2.1.0 バージョンを使用していることを確認する必要があります。 {% data variables.product.prodname_dotcom %} は SARIF ファイルを解析し、{% data variables.product.prodname_code_scanning %} エクスペリエンスの一部としてリポジトリの結果を使用してアラートを表示します。 詳細については、「[{% data variables.product.prodname_dotcom %} への SARIF ファイルのアップロード](/code-security/secure-coding/uploading-a-sarif-file-to-github)」を参照してください。 SARIF 2.1.0 JSON スキーマの詳細については、[`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json) を参照してください。 -If you're using {% data variables.product.prodname_actions %} with the {% data variables.code-scanning.codeql_workflow %}{% ifversion codeql-runner-supported %}, using the {% data variables.code-scanning.codeql_runner %},{% endif %} or using the {% data variables.product.prodname_codeql_cli %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)"{% ifversion codeql-runner-supported %}, "[Running {% data variables.code-scanning.codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)",{% endif %} or "[Installing CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)." +{% data variables.code-scanning.codeql_workflow %} で {% data variables.product.prodname_actions %} を使っている場合、{% ifversion codeql-runner-supported %}{% data variables.code-scanning.codeql_runner %} を使っている場合、{% endif %}または {% data variables.product.prodname_codeql_cli %} を使っている場合は、SARIF 2.1.0 のサポートされるサブセットが {% data variables.product.prodname_code_scanning %} によって自動的に使われます。 詳しくは、「[リポジトリの {% data variables.product.prodname_code_scanning %} の設定](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)」{% ifversion codeql-runner-supported %}、「[CI システムでの {% data variables.code-scanning.codeql_runner %} の実行](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)」、{% endif %}または「[CI システムでの CodeQL CLI のインストール](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)」をご覧ください。 -You can upload multiple SARIF files for the same commit, and display the data from each file as {% data variables.product.prodname_code_scanning %} results. When you upload multiple SARIF files for a commit, you must indicate a "category" for each analysis. The way to specify a category varies according to the analysis method: -- Using the {% data variables.product.prodname_codeql_cli %} directly, pass the `--sarif-category` argument to the `codeql database analyze` command when you generate SARIF files. For more information, see "[Configuring CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#about-generating-code-scanning-results-with-codeql-cli)." -- Using {% data variables.product.prodname_actions %} with `codeql-action/analyze`, the category is set automatically from the workflow name and any matrix variables (typically, `language`). You can override this by specifying a `category` input for the action, which is useful when you analyze different sections of a mono-repository in a single workflow. -- Using {% data variables.product.prodname_actions %} to upload results from other static analysis tools, then you must specify a `category` input if you upload more than one file of results for the same tool in one workflow. For more information, see "[Uploading a {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_actions %}](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." -- If you are not using either of these approaches, you must specify a unique `runAutomationDetails.id` in each SARIF file to upload. For more information about this property, see [`runAutomationDetails` object](#runautomationdetails-object) below. +同じコミットに対して複数の SARIF ファイルをアップロードし、各ファイルのデータを {% data variables.product.prodname_code_scanning %} の結果として表示できます。 コミット用に複数の SARIF ファイルをアップロードする場合は、分析ごとに "カテゴリ" を指定する必要があります。 カテゴリを指定する方法は、分析方法によって異なります。 +- {% data variables.product.prodname_codeql_cli %} を直接使用して、SARIF ファイルを生成するときに `--sarif-category` 引数を `codeql database analyze` コマンドに渡します。 詳細については、「[CI システムでの CodeQL CLI の設定](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#about-generating-code-scanning-results-with-codeql-cli)」を参照してください。 +- {% data variables.product.prodname_actions %} を `codeql-action/analyze` で使用すると、ワークフロー名とマトリックス変数 (通常は `language`) からカテゴリが自動的に設定されます。 これをオーバーライドするには、アクションの `category` 入力を指定します。これは、単一のワークフローでモノリポジトリのさまざまなセクションを分析する場合に便利です。 +- {% data variables.product.prodname_actions %} を使用して他の静的分析ツールから結果をアップロードする場合、1 つのワークフローで同じツールに対して複数の結果ファイルをアップロードするには、`category` 入力を指定する必要があります。 詳細については、「[{% data variables.product.prodname_actions %} を使用した {% data variables.product.prodname_code_scanning %} 分析のアップロード](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)」を参照してください。 +- これらの方法のいずれかを使用していない場合は、アップロードする SARIF ファイルごとに一意の `runAutomationDetails.id` を指定する必要があります。 このプロパティの詳細については、下記の「[`runAutomationDetails` オブジェクト](#runautomationdetails-object)」を参照してください。 -If you upload a second SARIF file for a commit with the same category and from the same tool, the earlier results are overwritten. However, if you try to upload multiple SARIF files for the same tool and category in a single {% data variables.product.prodname_actions %} workflow run, the misconfiguration is detected and the run will fail. +同じカテゴリと同じツールからコミット用の 2 つ目の SARIF ファイルをアップロードすると、以前の結果が上書きされます。 ただし、1 つの {% data variables.product.prodname_actions %} ワークフロー実行で同じツールとカテゴリに対して複数の SARIF ファイルをアップロードしようとすると、設定ミスが検出され、実行は失敗します。 -{% data variables.product.prodname_dotcom %} uses properties in the SARIF file to display alerts. For example, the `shortDescription` and `fullDescription` appear at the top of a {% data variables.product.prodname_code_scanning %} alert. The `location` allows {% data variables.product.prodname_dotcom %} to show annotations in your code file. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." +{% data variables.product.prodname_dotcom %} は、SARIF ファイルのプロパティを使用してアラートを表示します。 たとえば、`shortDescription` と `fullDescription` は {% data variables.product.prodname_code_scanning %} アラートの先頭に表示されます。 `location` により、{% data variables.product.prodname_dotcom %} がコード ファイルにアノテーションを表示できるようになります。 詳細については、「[リポジトリの {% data variables.product.prodname_code_scanning %} アラートの管理](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)」を参照してください。 -If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. +SARIF を使い慣れていなく、詳細を確認したい場合は、Microsoft の [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) リポジトリを参照してください。 -## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs +## 実行全体で {% data variables.product.prodname_code_scanning %} アラートを追跡するデータを提供する -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. +新しいコード スキャンの結果がアップロードされるたびに、結果が処理され、アラートがリポジトリに追加されます。 同じ問題に対するアラートの重複を防ぐために、{% data variables.product.prodname_code_scanning %} はフィンガープリントを使用してさまざまな実行結果を照合し、選択したブランチの最新の実行で 1 回だけ表示されるようにします。 これにより、ファイルが編集されたときに、アラートを適切なコードの行に照合させることができます。 結果の `ruleID` は、分析全体で同じである必要があります。 -### Reporting consistent filepaths +### 一貫性のあるファイルパスのレポート -The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. +安定したフィンガープリントの計算を可能にするために、ファイルパスは実行全体で一貫している必要があります。 同じ結果に対してファイルパスが異なる場合、新しい分析が行われるたびに新しいアラートが作成され、古いアラートが閉じられます。 これにより、同じ結果に対して複数のアラートが発生します。 -### Including data for fingerprint generation +### フィンガープリント生成用のデータを含める -{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. +{% data variables.product.prodname_dotcom %} は、OASIS 標準の `partialFingerprints` プロパティを使用して、2 つの結果が論理的に同一の場合に検出します。 詳細については、OASIS ドキュメントの [partialFingerprints プロパティ](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)のエントリを参照してください。 -SARIF files created by the {% data variables.code-scanning.codeql_workflow %}, {% ifversion codeql-runner-supported %}using the {% data variables.code-scanning.codeql_runner %}, {% endif %}or using the {% data variables.product.prodname_codeql_cli %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)." +{% data variables.code-scanning.codeql_workflow %} によって、{% ifversion codeql-runner-supported %}{% data variables.code-scanning.codeql_runner %} を使って、{% endif %}または {% data variables.product.prodname_codeql_cli %} を使って作成された SARIF ファイルには、フィンガープリント データが含まれます。 `upload-sarif` アクションを使用して SARIF ファイルをアップロードする場合にこのデータが欠落していると、{% data variables.product.prodname_dotcom %} は `partialFingerprints` フィールドにソース ファイルからデータの入力を試みます。 結果のアップロードの詳細については、「[{% data variables.product.prodname_dotcom %} への SARIF ファイルのアップロード](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)」を参照してください。 -If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)." +`/code-scanning/sarifs` API エンドポイントを使用してフィンガープリントデータなしで SARIF ファイルをアップロードする場合、{% data variables.product.prodname_code_scanning %} アラートが処理され表示されますが、アラートが重複して表示される場合があります。 重複するアラートが表示されないようにするには、SARIF ファイルをアップロードする前に、指紋データを計算し、`partialFingerprints` プロパティを設定する必要があります。 `upload-sarif` アクションで便利な始点 https://github.com/github/codeql-action/blob/main/src/fingerprints.ts が使用されるスクリプトが見つかる場合があります。 API の詳細については、「[SARIF データとして分析をアップロードする](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)」を参照してください。 -## Understanding rules and results +## ルールと結果について -SARIF files support both rules and results. The information stored in these elements is similar but serves different purposes. +SARIF ファイルは、ルールと結果の両方をサポートします。 これらの要素に格納されている情報は似ていますが、目的は異なります。 -- Rules are an array of `reportingDescriptor` objects that are included in the `toolComponent` object. This is where you store details of the rules that are run during analysis. Information in these objects should change infrequently, typically when you update the tool. +- ルールは、`toolComponent` オブジェクトに含まれる `reportingDescriptor` オブジェクトの配列です。 ここに、分析中に実行されるルールの詳細を格納します。 これらのオブジェクト内の情報は、通常、ツールを更新したときに変更される頻度が低いはずです。 -- Results are stored as a series of `result` objects under `results` in the `run` object. Each `result` object contains details for one alert in the codebase. Within the `results` object, you can reference the rule that detected the alert. +- 結果は、`run` オブジェクト内の `results` の下で、一連の `result` オブジェクトとして格納されます。 各 `result` オブジェクトには、コードベース内の 1 つのアラートの詳細が含まれています。 `results` オブジェクト内で、アラートを検出したルールを参照できます。 -When you compare SARIF files generated by analyzing different codebases with the same tool and rules, you should see differences in the results of the analyses but not in the rules. +異なるコードベースを同じツールとルールで分析して生成された SARIF ファイルを比較すると、分析の結果に違いが見られますが、ルールにはありません。 -## Specifying the root for source files +## ソース ファイルのルートの指定 -{% data variables.product.prodname_code_scanning_capc %} interprets results that are reported with relative paths as relative to the root of the repository analyzed. If a result contains an absolute URI, the URI is converted to a relative URI. The relative URI can then be matched against a file committed to the repository. +{% data variables.product.prodname_code_scanning_capc %} は、相対パスで報告された結果を、分析されたリポジトリのルートに対する相対パスとして解釈します。 結果に絶対 URI が含まれている場合、URI は相対 URI に変換されます。 その後、リポジトリにコミットされたファイルに対して相対 URI を照合できます。 -You can provide the source root for conversion from absolute to relative URIs in one of the following ways. +絶対 URI から相対 URI への変換のソース ルートは、次のいずれかの方法で指定できます。 -- [`checkout_path`](https://github.com/github/codeql-action/blob/c2c0a2908e95769d01b907f9930050ecb5cf050d/analyze/action.yml#L44-L47) input to the `github/codeql-action/analyze` action -- `checkout_uri` parameter to the SARIF upload API endpoint. For more information, see "[{% data variables.product.prodname_code_scanning_capc %}](/rest/code-scanning#upload-an-analysis-as-sarif-data)" in the REST API documentation -- [`invocation.workingDirectory.uri`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html#_Toc9244365) property in the SARIF file +- `github/codeql-action/analyze` アクションに対する [`checkout_path`](https://github.com/github/codeql-action/blob/c2c0a2908e95769d01b907f9930050ecb5cf050d/analyze/action.yml#L44-L47) 入力 +- SARIF アップロード API エンドポイントに対する `checkout_uri` パラメーター。 詳しくは、REST API ドキュメントの「[{% data variables.product.prodname_code_scanning_capc %}](/rest/code-scanning#upload-an-analysis-as-sarif-data)」をご覧ください。 +- SARIF ファイルの [`invocation.workingDirectory.uri`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html#_Toc9244365) プロパティ -If you provide a source root, any location of an artifact specified using an absolute URI must use the same URI scheme. If there is a mismatch between the URI scheme for the source root and one or more of the absolute URIs, the upload is rejected. +ソース ルートを指定する場合、絶対 URI を使用して指定された成果物の場所では、同じ URI スキームを使用する必要があります。 ソース ルートの URI スキームと 1 つ以上の絶対 URI の間に不一致がある場合、アップロードは拒否されます。 -For example, a SARIF file is uploaded using a source root of `file:///github/workspace`. +たとえば、SARIF ファイルは `file:///github/workspace` のソース ルートを使用してアップロードされます。 ``` # Conversion of absolute URIs to relative URIs for location artifacts @@ -92,155 +96,155 @@ file:///github/workspace/src/main.go -> src/main.go file:///tmp/go-build/tmp.go -> file:///tmp/go-build/tmp.go ``` -The file is successfully uploaded as both absolute URIs use the same URI scheme as the source root. +両方の絶対 URI でソース ルートと同じ URI スキームが使用されると、ファイルが正常にアップロードされます。 -## Validating your SARIF file +## SARIF ファイルを検証する -You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/). +SARIF ファイルが {% data variables.product.prodname_code_scanning %} と互換性があるかどうかは、{% data variables.product.prodname_dotcom %} 収集ルールと照らし合わせることで確認できます。 詳細については、[Microsoft SARIF 検証ツール](https://sarifweb.azurewebsites.net/)を参照してください。 {% data reusables.code-scanning.upload-sarif-alert-limit %} -## Supported SARIF output file properties +## サポートされている SARIF 出力ファイルのプロパティ -If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% data variables.product.prodname_codeql %} 以外のコード分析エンジンを使用する場合、サポートされている SARIF プロパティを確認して、{% data variables.product.prodname_dotcom %} での分析結果の表示方法を最適化できます。 {% note %} -**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. +**注:** "必須" としてマークされたプロパティには、明示的な値を指定する必要があります。 空の文字列は、必須のプロパティではサポートされていません。 {% endnote %} -Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. +有効な SARIF 2.1.0 出力ファイルはすべてアップロードできますが、{% data variables.product.prodname_code_scanning %} は以下のサポートされているプロパティのみを使用します。 -### `sarifLog` object +### `sarifLog` オブジェクト -| Name | Description | +| 名前 | 説明 | |----|----| -| `$schema` | **Required.** The URI of the SARIF JSON schema for version 2.1.0. For example, `https://json.schemastore.org/sarif-2.1.0.json`. | -| `version` | **Required.** {% data variables.product.prodname_code_scanning_capc %} only supports SARIF version `2.1.0`. -| `runs[]` | **Required.** A SARIF file contains an array of one or more runs. Each run represents a single run of an analysis tool. For more information about a `run`, see the [`run` object](#run-object). +| `$schema` | **必須。** バージョン 2.1.0 の SARIF JSON スキーマの URI。 たとえば、`https://json.schemastore.org/sarif-2.1.0.json` のようにします。 | +| `version` | **必須。** {% data variables.product.prodname_code_scanning_capc %} では、SARIF バージョン `2.1.0` のみがサポートされます。 +| `runs[]` | **必須。** SARIF ファイルには、1 つ以上の実行の配列が含まれています。 各実行は、分析ツールの 1 回の実行を表します。 `run` の詳細については、「[`run` オブジェクト](#run-object)」を参照してください。 -### `run` object +### `run` オブジェクト -{% data variables.product.prodname_code_scanning_capc %} uses the `run` object to filter results by tool and provide information about the source of a result. The `run` object contains the `tool.driver` tool component object, which contains information about the tool that generated the results. Each `run` can only have results for one analysis tool. +{% data variables.product.prodname_code_scanning_capc %} は `run` オブジェクトを使用して、ツールで結果をフィルターし、結果のソースに関する情報を提供します。 `run` オブジェクトには、結果を生成したツールに関する情報を含む `tool.driver` ツール コンポーネント オブジェクトが含まれます。 `run` ごとに、1 つの分析ツールの結果のみを取得できます。 -| Name | Description | +| 名前 | 説明 | |----|----| -| `tool.driver` | **Required.** A `toolComponent` object that describes the analysis tool. For more information, see the [`toolComponent` object](#toolcomponent-object). | -| `tool.extensions[]` | **Optional.** An array of `toolComponent` objects that represent any plugins or extensions used by the tool during analysis. For more information, see the [`toolComponent` object](#toolcomponent-object). | -| `invocation.workingDirectory.uri` | **Optional.** This field is used only when `checkout_uri` (SARIF upload API only) or `checkout_path` ({% data variables.product.prodname_actions %} only) are not provided. The value is used to convert absolute URIs used in [`physicalLocation` objects](#physicallocation-object) to relative URIs. For more information, see "[Specifying the root for source files](#specifying-the-root-for-source-files)."| -| `results[]` | **Required.** The results of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the results on {% data variables.product.prodname_dotcom %}. For more information, see the [`result` object](#result-object). +| `tool.driver` | **必須。** 分析ツールについて説明する `toolComponent` オブジェクト。 詳細については、「[`toolComponent` オブジェクト](#toolcomponent-object)」を参照してください。 | +| `tool.extensions[]` | **省略可。** 分析中にツールによって使用されるプラグインまたは拡張機能を表す `toolComponent` オブジェクトの配列。 詳細については、「[`toolComponent` オブジェクト](#toolcomponent-object)」を参照してください。 | +| `invocation.workingDirectory.uri` | **省略可。** このフィールドは、`checkout_uri` (SARIF アップロード API のみ) または `checkout_path` ({% data variables.product.prodname_actions %} のみ) が指定されていない場合にのみ使用されます。 この値は、[`physicalLocation` オブジェクト](#physicallocation-object)で使用される絶対 URI を相対 URI に変換するために使用されます。 詳しくは、「[ソース ファイルのルートの指定](#specifying-the-root-for-source-files)」を参照してください。| +| `results[]` | **必須。** 分析ツールの結果。 {% data variables.product.prodname_code_scanning_capc %} は {% data variables.product.prodname_dotcom %} に結果を表示します。 詳細については、「[`result` オブジェクト](#result-object)」を参照してください。 -### `toolComponent` object +### `toolComponent` オブジェクト -| Name | Description | +| 名前 | 説明 | |----|----| -| `name` | **Required.** The name of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} displays the name on {% data variables.product.prodname_dotcom %} to allow you to filter results by tool. | -| `version` | **Optional.** The version of the analysis tool. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. | -| `semanticVersion` | **Optional.** The version of the analysis tool, specified by the Semantic Versioning 2.0 format. {% data variables.product.prodname_code_scanning_capc %} uses the version number to track when results may have changed due to a tool version change rather than a change in the code being analyzed. If the SARIF file includes the `semanticVersion` field, `version` is not used by {% data variables.product.prodname_code_scanning %}. For more information, see "[Semantic Versioning 2.0.0](https://semver.org/)" in the Semantic Versioning documentation. | -| `rules[]` | **Required.** An array of `reportingDescriptor` objects that represent rules. The analysis tool uses rules to find problems in the code being analyzed. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). | +| `name` | **必須。** 分析ツールの名前。 {% data variables.product.prodname_code_scanning_capc %} は、{% data variables.product.prodname_dotcom %} に名前を表示して、ツールで結果をフィルタできるようにします。 | +| `version` | **省略可。** 分析ツールのバージョン。 {% data variables.product.prodname_code_scanning_capc %} は、バージョン番号を使用して、分析されているコードでの変更ではなく、ツールのバージョン変更により結果が変更された可能性がある場合に追跡します。 SARIF ファイルに `semanticVersion` フィールド含まれている場合、{% data variables.product.prodname_code_scanning %} では `version` が使用されません。 | +| `semanticVersion` | **省略可。** セマンティック バージョニング 2.0 形式で指定された分析ツールのバージョン。 {% data variables.product.prodname_code_scanning_capc %} は、バージョン番号を使用して、分析されているコードでの変更ではなく、ツールのバージョン変更により結果が変更された可能性がある場合に追跡します。 SARIF ファイルに `semanticVersion` フィールド含まれている場合、{% data variables.product.prodname_code_scanning %} では `version` が使用されません。 詳細については、セマンティック バージョニング ドキュメントの「[セマンティック バージョニング 2.0.0](https://semver.org/)」を参照してください。 | +| `rules[]` | **必須。** ルールを表す `reportingDescriptor` オブジェクトの配列。 分析ツールはルールを使用して、分析対象のコードの問題を見つけます。 詳細については、「[`reportingDescriptor` オブジェクト](#reportingdescriptor-object)」を参照してください。 | -### `reportingDescriptor` object +### `reportingDescriptor` オブジェクト -This is where you store details of the rules that are run during analysis. Information in these objects should change infrequently, typically when you update the tool. For more information, see "[Understanding rules and results](#understanding-rules-and-results)" above. +ここに、分析中に実行されるルールの詳細を格納します。 これらのオブジェクト内の情報は、通常、ツールを更新したときに変更される頻度が低いはずです。 詳しくは、上の「[ルールと結果について](#understanding-rules-and-results)」を参照してください。 -| Name | Description | +| 名前 | 説明 | |----|----| -| `id` | **Required.** A unique identifier for the rule. The `id` is referenced from other parts of the SARIF file and may be used by {% data variables.product.prodname_code_scanning %} to display URLs on {% data variables.product.prodname_dotcom %}. | -| `name` | **Optional.** The name of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the name to allow results to be filtered by rule on {% data variables.product.prodname_dotcom %}. | -| `shortDescription.text` | **Required.** A concise description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the short description on {% data variables.product.prodname_dotcom %} next to the associated results. -| `fullDescription.text` | **Required.** A description of the rule. {% data variables.product.prodname_code_scanning_capc %} displays the full description on {% data variables.product.prodname_dotcom %} next to the associated results. The max number of characters is limited to 1000. -| `defaultConfiguration.level` | **Optional.** Default severity level of the rule. {% data variables.product.prodname_code_scanning_capc %} uses severity levels to help you understand how critical the result is for a given rule. This value can be overridden by the `level` attribute in the `result` object. For more information, see the [`result` object](#result-object). Default: `warning`. -| `help.text` | **Required.** Documentation for the rule using text format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. -| `help.markdown` | **Recommended.** Documentation for the rule using Markdown format. {% data variables.product.prodname_code_scanning_capc %} displays this help documentation next to the associated results. When `help.markdown` is available, it is displayed instead of `help.text`. -| `properties.tags[]` | **Optional.** An array of strings. {% data variables.product.prodname_code_scanning_capc %} uses `tags` to allow you to filter results on {% data variables.product.prodname_dotcom %}. For example, it is possible to filter to all results that have the tag `security`. -| `properties.precision` | **Recommended.** A string that indicates how often the results indicated by this rule are true. For example, if a rule has a known high false-positive rate, the precision should be `low`. {% data variables.product.prodname_code_scanning_capc %} orders results by precision on {% data variables.product.prodname_dotcom %} so that the results with the highest `level`, and highest `precision` are shown first. Can be one of: `very-high`, `high`, `medium`, or `low`. -| `properties.problem.severity` | **Recommended.** A string that indicates the level of severity of any alerts generated by a non-security query. This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `problem.severity`, and highest `precision` are shown first. Can be one of: `error`, `warning`, or `recommendation`. -| `properties.security-severity` | **Recommended.** A string representing a score that indicates the level of severity, between 0.0 and 10.0, for security queries (`@tags` includes `security`). This, with the `properties.precision` property, determines whether the results are displayed by default on {% data variables.product.prodname_dotcom %} so that the results with the highest `security-severity`, and highest `precision` are shown first. {% data variables.product.prodname_code_scanning_capc %} translates numerical scores as follows: over 9.0 is `critical`, 7.0 to 8.9 is `high`, 4.0 to 6.9 is `medium` and 3.9 or less is `low`. - -### `result` object - -Each `result` object contains details for one alert in the codebase. Within the `results` object, you can reference the rule that detected the alert. For more information, see "[Understanding rules and results](#understanding-rules-and-results)" above. +| `id` | **必須。** ルールの一意の識別子。 `id` は SARIF ファイルの他の部分から参照され、{% data variables.product.prodname_code_scanning %} が {% data variables.product.prodname_dotcom %} に URL を表示するために使用できます。 | +| `name` | **省略可。** ルールの名前です。 {% data variables.product.prodname_code_scanning_capc %} は、{% data variables.product.prodname_dotcom %} のルールで結果をフィルタできるように名前を表示します。 | +| `shortDescription.text` | **必須。** ルールの簡潔な説明。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にある {% data variables.product.prodname_dotcom %} の簡単な説明を表示します。 +| `fullDescription.text` | **必須。** ルールの説明。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にある {% data variables.product.prodname_dotcom %} の説明全体を表示します。 文字数は最大 1000 文字に制限されています。 +| `defaultConfiguration.level` | **省略可。** ルールの既定の重大度レベル。 {% data variables.product.prodname_code_scanning_capc %} は、特定のルールの結果がどの程度重要であるかを理解するために、重要度レベルを使用します。 この値は、`result` オブジェクト内の `level` 属性でオーバーライドできます。 詳細については、「[`result` オブジェクト](#result-object)」を参照してください。 既定値:`warning`。 +| `help.text` | **必須。** テキスト形式を使用したルールのドキュメント。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にこのヘルプドキュメントを表示します。 +| `help.markdown` | **推奨。** Markdown 形式のルールのドキュメント。 {% data variables.product.prodname_code_scanning_capc %} は、関連する結果の横にこのヘルプドキュメントを表示します。 `help.markdown` が使用可能な場合は、`help.text` の代わりに表示されます。 +| `properties.tags[]` | **省略可。** 文字列の配列。 {% data variables.product.prodname_code_scanning_capc %} は、`tags` を使用して、{% data variables.product.prodname_dotcom %} の結果をフィルターできます。 たとえば、`security` タグを含むすべての結果をフィルターすることができます。 +| `properties.precision` | **推奨。** このルールによって示される結果が true となる頻度を示す文字列。 たとえば、ルールの誤検知率が高いことがわかっている場合、精度は `low` である必要があります。 {% data variables.product.prodname_code_scanning_capc %} は、{% data variables.product.prodname_dotcom %} の精度で結果を並べ替えるため、最高 `level` の精度と最高 `precision` の結果が最初に表示されます。 `very-high`、`high`、`medium`、`low` のいずれかにすることができます。 +| `properties.problem.severity` | **推奨。** セキュリティ以外のクエリによって生成されたアラートの重大度レベルを示す文字列。 これを `properties.precision` プロパティとともに使用すると、{% data variables.product.prodname_dotcom %} に既定で結果が表示されるかどうかが決定されるため、最高の `problem.severity` と最高の `precision` の結果が最初に表示されます。 `error`、`warning`、または `recommendation` のいずれかにすることができます。 +| `properties.security-severity` | **推奨。** セキュリティ クエリ (`@tags` には `security` が含まれる) の重大度のレベル (0.0 から 10.0) を示すスコアを表す文字列。 これを `properties.precision` プロパティとともに使用すると、{% data variables.product.prodname_dotcom %} に既定で結果が表示されるかどうかが決定されるため、最高の `security-severity` と最高の `precision` の結果が最初に表示されます。 {% data variables.product.prodname_code_scanning_capc %} は、数値スコアを次のように変換します。9.0 以上が `critical`、7.0 から 8.9 が `high`、4.0 から 6.9 が `medium`、3.9 以下が `low` です。 + +### `result` オブジェクト + +各 `result` オブジェクトには、コードベース内の 1 つのアラートの詳細が含まれています。 `results` オブジェクト内で、アラートを検出したルールを参照できます。 詳しくは、上の「[ルールと結果について](#understanding-rules-and-results)」を参照してください。 {% data reusables.code-scanning.upload-sarif-alert-limit %} -| Name | Description | +| 名前 | 説明 | |----|----| -| `ruleId`| **Optional.** The unique identifier of the rule (`reportingDescriptor.id`). For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). {% data variables.product.prodname_code_scanning_capc %} uses the rule identifier to filter results by rule on {% data variables.product.prodname_dotcom %}. -| `ruleIndex`| **Optional.** The index of the associated rule (`reportingDescriptor` object) in the tool component `rules` array. For more information, see the [`run` object](#run-object). The allowed range for this property 0 to 2^63 - 1. -| `rule`| **Optional.** A reference used to locate the rule (reporting descriptor) for this result. For more information, see the [`reportingDescriptor` object](#reportingdescriptor-object). -| `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. -| `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. -| `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. -| `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). -| `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). +| `ruleId`| **省略可。** ルールの一意識別子 (`reportingDescriptor.id`)。 詳細については、「[`reportingDescriptor` オブジェクト](#reportingdescriptor-object)」を参照してください。 {% data variables.product.prodname_code_scanning_capc %} は、ルール識別子を使用して、{% data variables.product.prodname_dotcom %} のルールで結果をフィルタします。 +| `ruleIndex`| **省略可。** ツール コンポーネント `rules` 配列内の関連するルール (`reportingDescriptor` オブジェクト) のインデックス。 詳細については、「[`run` オブジェクト](#run-object)」を参照してください。 このプロパティに使用できる範囲は 0 から 2^63 - 1 です。 +| `rule`| **省略可。** この結果のルール (レポート記述子) を見つけるために使用される参照。 詳細については、「[`reportingDescriptor` オブジェクト](#reportingdescriptor-object)」を参照してください。 +| `level`| **省略可。** 結果の重大度。 このレベルは、ルールで定義されているデフォルトの重要度をオーバーライドします。 {% data variables.product.prodname_code_scanning_capc %} は、レベルを使用して、{% data variables.product.prodname_dotcom %} の重要度で結果をフィルタします。 +| `message.text`| **必須。** 結果を説明するメッセージ。 {% data variables.product.prodname_code_scanning_capc %} は、結果のタイトルとしてメッセージテキストを表示します。 表示スペースが限られている場合、メッセージの最初の文のみが表示されます。 +| `locations[]`| **必須。** 最大 10 個の結果が検出された場所のセット。 指定された場所ごとに変更を加えることでのみ問題を修正できる場合を除き、1 つの場所のみを含める必要があります。 **メモ:** {% data variables.product.prodname_code_scanning %} が結果を表示するには、少なくとも 1 つの場所が必要です。 {% data variables.product.prodname_code_scanning_capc %} は、このプロパティを使用して、結果を注釈するファイルを決定します。 この配列の最初の値のみが使用されます。 他のすべての値は無視されます。 +| `partialFingerprints`| **必須。** 結果の一意の ID を追跡するために使用される文字列のセット。 {% data variables.product.prodname_code_scanning_capc %} は、`partialFingerprints` を使用して、コミットとブランチで同じ結果であるものを正確に識別します。 {% data variables.product.prodname_code_scanning_capc %} は、`partialFingerprints` がある場合、それを使用しようとします。 サード パーティーの SARIF ファイルを `upload-action` でアップロードしているときに `partialFingerprints` が SARIF ファイルに含まれていない場合は、このアクションで作成されます。 詳しくは、「[実行全体でコード スキャン アラートを追跡するデータを提供する](#providing-data-to-track-code-scanning-alerts-across-runs)」を参照してください。 **メモ:** {% data variables.product.prodname_code_scanning_capc %} では `primaryLocationLineHash` のみが使用されます。 +| `codeFlows[].threadFlows[].locations[]`| **省略可。** 実行スレッドを介したプログラムの進行状況を記述する、`threadFlow` オブジェクトの `location` オブジェクトの配列。 `codeFlow` オブジェクトは、結果の検出に使用されるコード実行パターンを記述します。 コードフローが入力されている場合、{% data variables.product.prodname_code_scanning %} は、関連する結果の {% data variables.product.prodname_dotcom %} のコードフローを拡張します。 詳細については、「[`location` オブジェクト](#location-object)」を参照してください。 +| `relatedLocations[]`| この結果に関連する場所。 結果メッセージに埋め込まれている場合、{% data variables.product.prodname_code_scanning_capc %} は、関連する場所にリンクします。 詳細については、「[`location` オブジェクト](#location-object)」を参照してください。 -### `location` object +### `location` オブジェクト -A location within a programming artifact, such as a file in the repository or a file that was generated during a build. +プログラミングアーティファクト内の場所（リポジトリ内のファイルやビルド中に生成されたファイルなど）。 -| Name | Description | +| 名前 | 説明 | |----|----| -| `location.id` | **Optional.** A unique identifier that distinguishes this location from all other locations within a single result object. The allowed range for this property 0 to 2^63 - 1. -| `location.physicalLocation` | **Required.** Identifies the artifact and region. For more information, see the [`physicalLocation`](#physicallocation-object). -| `location.message.text` | **Optional.** A message relevant to the location. +| `location.id` | **省略可。** この場所を単一の結果オブジェクト内の他のすべての場所と区別する一意の識別子。 このプロパティに使用できる範囲は 0 から 2^63 - 1 です。 +| `location.physicalLocation` | **必須。** アーティファクトとリージョンを識別します。 詳細については、[`physicalLocation`](#physicallocation-object) を参照してください。 +| `location.message.text` | **省略可。** 場所に関連するメッセージ。 -### `physicalLocation` object +### `physicalLocation` オブジェクト -| Name | Description | +| 名前 | 説明 | |----|----| -| `artifactLocation.uri`| **Required.** A URI indicating the location of an artifact, usually a file either in the repository or generated during a build. For the best results we recommend that this is a relative path from the root of the GitHub repository being analyzed. For example, `src/main.js`. For more information about artifact URIs, see "[Specifying the root for source files](#specifying-the-root-for-source-files)."| -| `region.startLine` | **Required.** The line number of the first character in the region. -| `region.startColumn` | **Required.** The column number of the first character in the region. -| `region.endLine` | **Required.** The line number of the last character in the region. -| `region.endColumn` | **Required.** The column number of the character following the end of the region. +| `artifactLocation.uri`| **必須。** アーティファクトの場所を示す URI (通常はリポジトリ内にあるか、ビルド中に生成されたファイル)。 最良の結果を得るには、これが分析対象の GitHub リポジトリのルートからの相対パスであることをお勧めします。 たとえば、「 `src/main.js` 」のように入力します。 成果物 URI について詳しくは、「[ソース ファイルのルートの指定](#specifying-the-root-for-source-files)」を参照してください。| +| `region.startLine` | **必須。** リージョンの最初の文字の行番号。 +| `region.startColumn` | **必須。** リージョンの最初の文字の列番号。 +| `region.endLine` | **必須。** リージョンの最後の文字の行番号。 +| `region.endColumn` | **必須。** リージョンの末尾に続く文字の列番号。 -### `runAutomationDetails` object +### `runAutomationDetails` オブジェクト -The `runAutomationDetails` object contains information that specifies the identity of a run. +`runAutomationDetails` オブジェクトには、実行の ID を指定する情報が含まれています。 {% note %} -**Note:** `runAutomationDetails` is a SARIF v2.1.0 object. If you're using the {% data variables.product.prodname_codeql_cli %}, you can specify the version of SARIF to use. The equivalent object to `runAutomationDetails` is `.automationId` for SARIF v1 and `.automationLogicalId` for SARIF v2. +**メモ:** `runAutomationDetails` は SARIF v2.1.0 オブジェクトです。 {% data variables.product.prodname_codeql_cli %}を使っているなら、使用するSARIFのバージョンを指定できます。 `runAutomationDetails` と同等のオブジェクトは、SARIF v1 で `.automationId`、SARIF v2 で `.automationLogicalId` です。 {% endnote %} -| Name | Description | +| 名前 | 説明 | |----|----| -| `id`| **Optional.** A string that identifies the category of the analysis and the run ID. Use if you want to upload multiple SARIF files for the same tool and commit, but performed on different languages or different parts of the code. | +| `id`| **省略可。** 分析のカテゴリと実行 ID を識別する文字列。 同じツールとコミットに対して、ただし様々な言語やコードの様々な部分にを処理した場合に、複数のSARIFファイルをアップロードする際に使ってください。 | -The use of the `runAutomationDetails` object is optional. +`runAutomationDetails` オブジェクトの使用は省略可能です。 -The `id` field can include an analysis category and a run ID. We don't use the run ID part of the `id` field, but we store it. +`id` フィールドには、分析のカテゴリと実行 ID を含めることができます。 `id` フィールドの実行 ID の部分は使いませんが、保存はされます。 -Use the category to distinguish between multiple analyses for the same tool or commit, but performed on different languages or different parts of the code. Use the run ID to identify the specific run of the analysis, such as the date the analysis was run. +カテゴリを使って、同じツールあるいはコミットに対して行われる、ただし様々な言語やコードの様々な部分に対して行われる複数の分析を区別してください。 実行IDを使って、分析が実行された日付など、特定の分析の実行を識別してください。 -`id` is interpreted as `category/run-id`. If the `id` contains no forward slash (`/`), then the entire string is the `run_id` and the `category` is empty. Otherwise, `category` is everything in the string until the last forward slash, and `run_id` is everything after. +`id` は `category/run-id` として解釈されます。 `id` にスラッシュ (`/`) が含まれていない場合は、文字列全体が `run_id` であり、`category` は空です。 それ以外の場合、`category` は最後のスラッシュまでの文字列内のすべてであり、`run_id` はそれ以降のすべてです。 | `id` | category | `run_id` | |----|----|----| | my-analysis/tool1/2021-02-01 | my-analysis/tool1 | 2021-02-01 -| my-analysis/tool1/ | my-analysis/tool1 | _no `run-id`_ -| my-analysis for tool1 | _no category_ | my-analysis for tool1 +| my-analysis/tool1/ | my-analysis/tool1 | _`run-id` なし_ +| my-analysis for tool1 | _カテゴリなし_ | my-analysis for tool1 -- The run with an `id` of "my-analysis/tool1/2021-02-01" belongs to the category "my-analysis/tool1". Presumably, this is the run from February 2, 2021. -- The run with an `id` of "my-analysis/tool1/" belongs to the category "my-analysis/tool1" but is not distinguished from other runs in that category. -- The run whose `id` is "my-analysis for tool1 " has a unique identifier but cannot be inferred to belong to any category. +- "my-analysis/tool1/2021-02-01" という `id` での実行は、"my-analysis/tool1" というカテゴリに属します。 おそらく、これは2021 年2月2日からの実行です。 +- "my-analysis/tool1/" という `id` での実行は "my-analysis/tool1" というカテゴリに属しますが、そのカテゴリの他の実行とは区別されません。 +- "my-analysis for tool1" が `id` の実行は、一意の識別子を持ちますが、いずれかのカテゴリに属していると推定できません。 -For more information about the `runAutomationDetails` object and the `id` field, see [runAutomationDetails object](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479) in the OASIS documentation. +`runAutomationDetails` オブジェクトと `id` フィールドの詳細については、OASIS ドキュメントの「[runAutomationDetails オブジェクト](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012479)」を参照してください。 -Note that the rest of the supported fields are ignored. +サポートされている残りのフィールドは無視されることに注意してください。 -## SARIF output file examples +## SARIF 出力ファイルの例 -These example SARIF output files show supported properties and example values. +次の例の SARIF 出力ファイルは、サポートされているプロパティと値の例を示しています。 -### Example with minimum required properties +### 最低限必要なプロパティの例 -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +次の SARIF 出力ファイルには、{% data variables.product.prodname_code_scanning %} の結果が期待どおりに機能するために最低限必要なプロパティを示す値の例が示されています。 プロパティを削除したり、値を省略したり、空の文字列を使用した場合、このデータは正しく表示されないか、{% data variables.product.prodname_dotcom %} で同期されません。 ```json { @@ -296,9 +300,9 @@ This SARIF output file has example values to show the minimum required propertie } ``` -### Example showing all supported SARIF properties +### サポートされているすべての SARIF プロパティを示す例 -This SARIF output file has example values to show all supported SARIF properties for {% data variables.product.prodname_code_scanning %}. +次の SARIF 出力ファイルには、{% data variables.product.prodname_code_scanning %} でサポートされているすべての SARIF プロパティを示す値の例が示されています。 ```json { diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md index a2d8162af9ea..67bee2d7898a 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md @@ -1,7 +1,7 @@ --- -title: Migrating from the CodeQL runner to CodeQL CLI +title: CodeQL ランナーから CodeQL CLI への移行 shortTitle: Migrating from the CodeQL runner -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to complete the same tasks as with the {% data variables.code-scanning.codeql_runner %}.' +intro: '{% data variables.product.prodname_codeql_cli %} を使用して、{% data variables.code-scanning.codeql_runner %} と同じタスクを完了できます。' product: '{% data reusables.gated-features.code-scanning %}' versions: fpt: '*' @@ -12,52 +12,57 @@ topics: - Advanced Security - Code scanning - CodeQL +ms.openlocfilehash: 10711111e3fa5c7226574ac9b70eb4bd4d5bff21 +ms.sourcegitcommit: b617c4a7a1e4bf2de3987a86e0eb217d7031490f +ms.translationtype: HT +ms.contentlocale: ja-JP +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148161265' --- +# {% data variables.code-scanning.codeql_runner %} から {% data variables.product.prodname_codeql_cli %} への移行 -# Migrating from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %} +{% data variables.code-scanning.codeql_runner %} は非推奨になっています。 代わりに {% data variables.product.prodname_codeql_cli %} バージョン 2.6.2 以降をお使いいただけます。 +このドキュメントでは、一般的なワークフローを {% data variables.code-scanning.codeql_runner %} から {% data variables.product.prodname_codeql_cli %} に移行する方法について説明します。 -The {% data variables.code-scanning.codeql_runner %} is being deprecated. You can use the {% data variables.product.prodname_codeql_cli %} version 2.6.2 and greater instead. -This document describes how to migrate common workflows from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %}. +## インストール -## Installation +**{% data variables.product.prodname_codeql %} バンドルを** [`github/codeql-action` リポジトリ](https://github.com/github/codeql-action/releases)からダウンロードします。 このバンドルには、{% data variables.product.prodname_codeql_cli %} および、標準の {% data variables.product.prodname_codeql %} クエリとライブラリが含まれています。 -Download the **{% data variables.product.prodname_codeql %} bundle** from the [`github/codeql-action` repository](https://github.com/github/codeql-action/releases). This bundle contains the {% data variables.product.prodname_codeql_cli %} and the standard {% data variables.product.prodname_codeql %} queries and libraries. +{% data variables.product.prodname_codeql_cli %} の設定の詳細については、「[CI システムでの {% data variables.product.prodname_codeql_cli %} のインストール](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)」を参照してください。 -For more information on setting up the {% data variables.product.prodname_codeql_cli %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)." +## ワークフローの変更の概要 -## Overview of workflow changes +{% data variables.code-scanning.codeql_runner %} を使用してコードベースを分析する一般的なワークフローには、次の手順があります。 +- `codeql-runner- init` により、{% data variables.product.prodname_codeql %} データベースの作成を開始して、構成を読み取ります。 +- コンパイル済み言語の場合: `init` ステップによって生成される環境変数を設定します。 +- コンパイル済み言語の場合: 自動ビルドまたは手動ビルド手順を実行します。 +- `codeql-runner- analyze` により {% data variables.product.prodname_codeql %} データベースの作成を完了し、クエリを実行して各 {% data variables.product.prodname_codeql %} データベースを分析して、SARIF ファイルで結果を要約し、結果を {% data variables.product.prodname_dotcom %} にアップロードします。 -A typical workflow that uses the {% data variables.code-scanning.codeql_runner %} to analyze a codebase has the following steps. -- `codeql-runner- init` to start creating {% data variables.product.prodname_codeql %} databases and read the configuration. -- For compiled languages: set environment variables produced by the `init` step. -- For compiled languages: run autobuild or manual build steps. -- `codeql-runner- analyze` to finish creating {% data variables.product.prodname_codeql %} databases, run queries to analyze each {% data variables.product.prodname_codeql %} database, summarize the results in a SARIF file, and upload the results to {% data variables.product.prodname_dotcom %}. +{% data variables.product.prodname_codeql_cli %} を使用してコードベースを分析する一般的なワークフローには、次の手順があります。 +- `codeql database create` によって、{% data variables.product.prodname_codeql %} データベースを作成します。 + - コンパイル済み言語の場合: 必要に応じてビルド コマンドを指定します。 +- `codeql database analyze` では、クエリを実行して各 {% data variables.product.prodname_codeql %} データベースを分析し、結果を SARIF ファイルにまとめます。 このコマンドは、言語またはデータベースごとに 1 回実行する必要があります。 +- `codeql github upload-results` により、結果の SARIF ファイルを {% data variables.product.prodname_dotcom %} にアップロードし、コード スキャン アラートとして表示します。 このコマンドは、言語または SARIF ファイルごとに 1 回実行する必要があります。 -A typical workflow that uses the {% data variables.product.prodname_codeql_cli %} to analyze a codebase has the following steps. -- `codeql database create` to create {% data variables.product.prodname_codeql %} databases. - - For compiled languages: Optionally provide a build command. -- `codeql database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. This command must be run once for each language or database. -- `codeql github upload-results` to upload the resulting SARIF files to {% data variables.product.prodname_dotcom %}, to be displayed as code scanning alerts. This command must be run once for each language or SARIF file. +{% data variables.code-scanning.codeql_runner %} は、既定ではマルチスレッドです。 既定では、{% data variables.product.prodname_codeql_cli %} により単一のスレッドのみが使用されますが、使用するスレッドの数を指定できます。 {% data variables.code-scanning.codeql_runner %} の動作をレプリケートして、{% data variables.product.prodname_codeql_cli %} を使用するときにマシンで使用可能なすべてのスレッドを使用する場合は、`--threads 0` を `codeql database analyze` に渡します。 -The {% data variables.code-scanning.codeql_runner %} is multithreaded by default. The {% data variables.product.prodname_codeql_cli %} only uses a single thread by default, but allows you to specify the amount of threads you want it to use. If you want to replicate the behavior of the {% data variables.code-scanning.codeql_runner %} to use all threads available on the machine when using the {% data variables.product.prodname_codeql_cli %}, you can pass `--threads 0` to `codeql database analyze`. +詳細については、「[CI システムでの {% data variables.product.prodname_codeql_cli %} の構成](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)」を参照してください。 -For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." +## {% data variables.product.prodname_codeql_cli %} の一般的な使用例 -## Examples of common uses for the {% data variables.product.prodname_codeql_cli %} +### 例について -### About the examples +これらの例では、ソース コードが現在の作業ディレクトリにチェックアウトされていることを前提としています。 別のディレクトリを使用する場合は、それに応じて `--source-root` 引数とビルド手順を変更します。 -These examples assume that the source code has been checked out to the current working directory. If you use a different directory, change the `--source-root` argument and the build steps accordingly. +また、これらの例では、{% data variables.product.prodname_codeql_cli %} が現在の PATH に配置されていることも前提としています。 -These examples also assume that the {% data variables.product.prodname_codeql_cli %} is placed on the current PATH. +これらの例では、適切なスコープを持つ {% data variables.product.prodname_dotcom %} トークンが `$TOKEN` 環境変数に格納され、`stdin` を介して、サンプル コマンドに渡されるか、`$GITHUB_TOKEN` 環境変数に格納されます。 -In these examples, a {% data variables.product.prodname_dotcom %} token with suitable scopes is stored in the `$TOKEN` environment variable and passed to the example commands via `stdin`, or is stored in the `$GITHUB_TOKEN` environment variable. +これらの例でチェックアウトおよび分析されている ref 名とコミット SHA は、ワークフロー中に認識されます。 ブランチの場合は、ref として使用 `refs/heads/BRANCH-NAME` します。pull request のヘッド コミットには `refs/pull/NUMBER/head` を使用します。 pull request の {% data variables.product.prodname_dotcom %} で生成されたマージ コミットの場合は、`refs/pull/NUMBER/merge` を使用します。 下記の例では、`refs/heads/main` を使用しています。 別のブランチ名を使用する場合は、サンプル コードを変更する必要があります。 -The ref name and commit SHA being checked out and analyzed in these examples are known during the workflow. For a branch, use `refs/heads/BRANCH-NAME` as the ref. For the head commit of a pull request, use `refs/pull/NUMBER/head`. For a {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request, use `refs/pull/NUMBER/merge`. The examples below all use `refs/heads/main`. If you use a different branch name, you must modify the sample code. +### 単一のコンパイルされていない言語 (JavaScript) -### Single non-compiled language (JavaScript) - -Runner: +ランナー: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -82,11 +87,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single non-compiled language (JavaScript) using a different query suite (security-and-quality) +### 別のクエリ スイート (セキュリティと品質) を使用する単一のコンパイルされていない言語 (JavaScript) -A similar approach can be taken for compiled languages, or multiple languages. +コンパイル済みの言語や複数の言語に対しても、同様の方法を使用できます。 -Runner: +ランナー: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -112,11 +117,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single non-compiled language (JavaScript) using a custom configuration file +### カスタム構成ファイルを使用する単一のコンパイルされていない言語 (JavaScript) -A similar approach can be taken for compiled languages, or multiple languages. +コンパイル済みの言語や複数の言語に対しても、同様の方法を使用できます。 -Runner: +ランナー: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -143,9 +148,9 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single compiled language using autobuild (Java) +### 自動ビルドを使用する単一のコンパイル済みの言語 (Java) -Runner: +ランナー: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages java \ @@ -177,9 +182,9 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-java.sarif --github-auth-stdin ``` -### Single compiled language using a custom build command (Java) +### カスタム ビルド コマンドを使用する単一のコンパイル済みの言語 (Java) -Runner: +ランナー: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages java \ @@ -210,11 +215,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-java.sarif --github-auth-stdin ``` -### Single compiled language using indirect build tracing (C# on Windows within Azure DevOps) +### 間接ビルド トレースを使用する単一のコンパイル済み言語 (Azure DevOps 内のWindows 上の C#) -Indirect build tracing for a compiled language enables {% data variables.product.prodname_codeql %} to detect all build steps between the `init` and `analyze` steps, when the code cannot be built using the autobuilder or an explicit build command line. This is useful when using preconfigured build steps from your CI system, such as the `VSBuild` and `MSBuild` tasks in Azure DevOps. +コンパイル済み言語の間接ビルド トレースを使用すると、{% data variables.product.prodname_codeql %} で、オートビルダーまたは明示的なビルド コマンド ラインを使用してコードをビルドできない場合に、`init` と `analyze` ステップの間のすべてのビルド ステップを検出できるようになります。 これは、CI システムから、Azure DevOps 内の `VSBuild` と `MSBuild` タスクなどの、構成済みのビルド ステップを使用する場合に便利です。 -Runner: +ランナー: ```yaml - task: CmdLine@1 displayName: CodeQL Initialization @@ -332,12 +337,12 @@ CLI: ``` -### Multiple languages using autobuild (C++, Python) +### 自動ビルドを使用する複数の言語 (C++、Python) -This example is not strictly possible with the {% data variables.code-scanning.codeql_runner %}. -Only one language (the compiled language with the most files) will be analyzed. +この例は、{% data variables.code-scanning.codeql_runner %} では厳密には可能ではありません。 +分析されるのは、1 つの言語 (ほとんどのファイルを含むコンパイル済みの言語) だけです。 -Runner: +ランナー: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages cpp,python \ @@ -375,9 +380,9 @@ for language in cpp python; do done ``` -### Multiple languages using a custom build command (C++, Python) +### カスタム ビルド コマンドを使用する複数の言語 (C++、Python) -Runner: +ランナー: ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages cpp,python \ diff --git a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md b/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md index 0e56df084315..692b4c28a681 100644 --- a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md +++ b/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md @@ -20,7 +20,13 @@ shortTitle: GPG verification After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_github_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." -Once you enable GPG verification, it will immediately take effect for all your codespaces. +{% data reusables.codespaces.gpg-in-active-codespaces %} + +{% note %} + +**Note:** If you have linked a dotfiles repository with {% data variables.product.prodname_github_codespaces %}, the Git configuration in your dotfiles may conflict with the configuration that {% data variables.product.prodname_github_codespaces %} requires to sign commits. For more information, see "[Troubleshooting GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces)." + +{% endnote %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} @@ -30,8 +36,4 @@ Once you enable GPG verification, it will immediately take effect for all your c !["Selected repositories" dropdown menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) -{% note %} - -**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, you also must append `-S` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings. - -{% endnote %} +Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, all commits are signed by default in your codespaces. \ No newline at end of file diff --git a/translations/ja-JP/content/codespaces/troubleshooting/index.md b/translations/ja-JP/content/codespaces/troubleshooting/index.md index 2aeca351ebd3..cabc8b2247c8 100644 --- a/translations/ja-JP/content/codespaces/troubleshooting/index.md +++ b/translations/ja-JP/content/codespaces/troubleshooting/index.md @@ -19,6 +19,7 @@ children: - /troubleshooting-dotfiles-for-codespaces - /troubleshooting-port-forwarding-for-github-codespaces - /troubleshooting-github-codespaces-clients + - /troubleshooting-gpg-verification-for-github-codespaces - /working-with-support-for-github-codespaces --- diff --git a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 7f68a7bb8873..fdfc96b3885c 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1,6 +1,6 @@ --- title: Webhook events and payloads -intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.' +intro: 'Learn about when each webhook event occurs and what the payload contains.' product: '{% data reusables.gated-features.enterprise_account_webhooks %}' redirect_from: - /early-access/integrations/webhooks @@ -97,1568 +97,4 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. > } ``` -{% ifversion fpt or ghes > 3.3 or ghae or ghec %} -## branch_protection_rule - -Activity related to a branch protection rule. For more information, see "[About branch protection rules](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`rule` | `object` | The branch protection rule. Includes a `name` and all the [branch protection settings](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. -`changes` | `object` | If the action was `edited`, the changes to the rule. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.branch_protection_rule.edited }} -{% endif %} - -{% ifversion ghes > 3.3 %} -## cache_sync - -A Git ref has been successfully synced to a cache replica. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`cache_location` |`string` | The location of the cache server that has been updated. -`ref` | `string` | The ref that has been updated. -`before` | `string` | The OID of the ref on the cache replica before it was updated. -`after` | `string` | The OID of the ref on the cache replica after the update. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.cache_sync.synced }} -{% endif %} - -## check_run - -{% data reusables.webhooks.check_run_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `created` and `completed` event types in a repository -- Organization webhooks only receive payloads for the `created` and `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_run_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_run.created }} - -## check_suite - -{% data reusables.webhooks.check_suite_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `completed` event types in a repository -- Organization webhooks only receive payloads for the `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_suite_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_suite.completed }} - -## code_scanning_alert - -{% data reusables.webhooks.code_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.code_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `reopened_by_user` or `closed_by_user`, the `sender` object will be the user that triggered the event. The `sender` object is {% ifversion fpt or ghec %}`github`{% elsif ghes or ghae %}`github-enterprise`{% else %}empty{% endif %} for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.code_scanning_alert.reopened }} - -## commit_comment - -{% data reusables.webhooks.commit_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.commit_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.commit_comment.created }} - -{% ifversion ghes < 3.4 %} -## content_reference - -{% data reusables.webhooks.content_reference_short_desc %} - -Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" to create a new content attachment. - -### Availability - -- {% data variables.product.prodname_github_apps %} with the `content_references:write` permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.content_reference.created }} - -{% endif %} -## create - -{% data reusables.webhooks.create_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you create more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.create_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.create }} - -## delete - -{% data reusables.webhooks.delete_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you delete more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.delete_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.delete }} - -{% ifversion fpt or ghec %} -## dependabot_alert - -{% data reusables.webhooks.dependabot_alert_description %} - -### Availability - -{% data reusables.webhooks.dependabot_alert_availability %} - -### Webhook payload object - -{% data reusables.webhooks.dependabot_alert_payload %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.dependabot_alert.fixed }} -{% endif %} - -## deploy_key - -{% data reusables.webhooks.deploy_key_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.deploy_key_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deploy_key.created }} - -## deployment - -{% data reusables.webhooks.deployment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments). -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment }} - -## deployment_status - -{% data reusables.webhooks.deployment_status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment_status` |`object` | The [deployment status](/rest/reference/deployments#list-deployment-statuses). -`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`deployment_status["target_url"]` |`string` | The optional link added to the status. -`deployment_status["description"]`|`string` | The optional human-readable description added to the status. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments) that this status is associated with. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment_status }} - -{% ifversion fpt or ghec %} -## discussion - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a discussion. For more information, see the "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, `deleted`, `pinned`, `unpinned`, `locked`, `unlocked`, `transferred`, `category_changed`, `answered`, `unanswered`, `labeled`, or `unlabeled`. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion.created }} - -## discussion_comment - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a comment in a discussion. For more information, see "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`comment` | `object` | The [`discussion comment`](/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion_comment.created }} -{% endif %} - -{% ifversion ghes or ghae %} - -## enterprise - -{% data reusables.webhooks.enterprise_short_desc %} - -### Availability - -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `anonymous_access_enabled` or `anonymous_access_disabled`. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.enterprise.anonymous_access_enabled }} - -{% endif %} - -## fork - -{% data reusables.webhooks.fork_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.fork_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.fork }} - -## github_app_authorization - -When someone revokes their authorization of a {% data variables.product.prodname_github_app %}, this event occurs. A {% data variables.product.prodname_github_app %} receives this webhook by default and cannot unsubscribe from this event. - -{% data reusables.webhooks.authorization_event %} For details about user-to-server requests, which require {% data variables.product.prodname_github_app %} authorization, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `revoked`. -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.github_app_authorization.revoked }} - -## gollum - -{% data reusables.webhooks.gollum_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.gollum_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.gollum }} - -## installation - -{% data reusables.webhooks.installation_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation.deleted }} - -## installation_repositories - -{% data reusables.webhooks.installation_repositories_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_repositories_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation_repositories.added }} - -## issue_comment - -{% data reusables.webhooks.issue_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_comment_webhook_properties %} -{% data reusables.webhooks.issue_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.issue_comment.created }} - -## issues - -{% data reusables.webhooks.issues_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_webhook_properties %} -{% data reusables.webhooks.issue_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone edits an issue - -{{ webhookPayloadsForCurrentVersion.issues.edited }} - -## label - -{% data reusables.webhooks.label_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Can be `created`, `edited`, or `deleted`. -`label`|`object` | The label that was added. -`changes`|`object`| The changes to the label if the action was `edited`. -`changes[name][from]`|`string` | The previous version of the name if the action was `edited`. -`changes[color][from]`|`string` | The previous version of the color if the action was `edited`. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.label.deleted }} - -{% ifversion fpt or ghec %} -## marketplace_purchase - -Activity related to a GitHub Marketplace purchase. {% data reusables.webhooks.action_type_desc %} For more information, see the "[GitHub Marketplace](/marketplace/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` | `string` | The action performed for a [GitHub Marketplace](https://github.com/marketplace) plan. Can be one of:
  • `purchased` - Someone purchased a GitHub Marketplace plan. The change should take effect on the account immediately.
  • `pending_change` - You will receive the `pending_change` event when someone has downgraded or cancelled a GitHub Marketplace plan to indicate a change will occur on the account. The new plan or cancellation takes effect at the end of the billing cycle. The `cancelled` or `changed` event type will be sent when the billing cycle has ended and the cancellation or new plan should take effect.
  • `pending_change_cancelled` - Someone has cancelled a pending change. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.
  • `changed` - Someone has upgraded or downgraded a GitHub Marketplace plan and the change should take effect on the account immediately.
  • `cancelled` - Someone cancelled a GitHub Marketplace plan and the last billing cycle has ended. The change should take effect on the account immediately.
- -For a detailed description of this payload and the payload for each type of `action`, see [{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/). - -### Webhook payload example when someone purchases the plan - -{{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }} - -{% endif %} - -## member - -{% data reusables.webhooks.member_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.member_webhook_properties %} -{% data reusables.webhooks.member_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.member.added }} - -## membership - -{% data reusables.webhooks.membership_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.membership_properties %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.membership.removed }} - -{% ifversion fpt or ghec %} - -## merge_group - -{% data reusables.pull_requests.merge-queue-beta %} - -Activity related to merge groups in a merge queue. The type of activity is specified in the action property of the payload object. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Merge queues** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Currently, can only be `checks_requested`. -`merge_group`|`object` | The merge group. -`merge_group[head_sha]`|`string` | The SHA of the merge group. -`merge_group[head_ref]`|`string` | The full ref of the merge group. -`merge_group[base_sha]`|`string` | The SHA of the merge group's parent commit. -`merge_group[base_ref]`|`string` | The full ref of the branch the merge group will be merged into. -`merge_group[head_commit]`|`object` | An expanded representation of the `head_sha` commit. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.merge_group.checks_requested }} - -{% endif %} - -## meta - -The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `deleted`. -`hook_id` |`integer` | The id of the modified webhook. -`hook` |`object` | The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.meta.deleted }} - -## milestone - -{% data reusables.webhooks.milestone_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.milestone_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.milestone.created }} - -## organization - -{% data reusables.webhooks.organization_short_desc %} - -### Availability - -{% ifversion ghes or ghae %} -- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} -- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of:{% ifversion ghes or ghae %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`. -`invitation` |`object` | The invitation for the user or email if the action is `member_invited`. -`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.organization.member_added }} - -{% ifversion fpt or ghec %} - -## org_block - -{% data reusables.webhooks.org_block_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`action` | `string` | The action performed. Can be `blocked` or `unblocked`. -`blocked_user` | `object` | Information about the user that was blocked or unblocked. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.org_block.blocked }} - -{% endif %} - -## package - -Activity related to {% data variables.product.prodname_registry %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[Managing packages with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages)" to learn more about {% data variables.product.prodname_registry %}. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.package_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.package.published }} - -## page_build - -{% data reusables.webhooks.page_build_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pages** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`id` | `integer` | The unique identifier of the page build. -`build` | `object` | The [List GitHub Pages builds](/rest/reference/pages#list-github-pages-builds) itself. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.page_build }} - -## ping - -{% data reusables.webhooks.ping_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} receive a ping event with an `app_id` used to register the app - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`zen` | `string` | Random string of GitHub zen. -`hook_id` | `integer` | The ID of the webhook that triggered the ping. -`hook` | `object` | The [webhook configuration](/rest/reference/webhooks#get-a-repository-webhook). -`hook[app_id]` | `integer` | When you register a new {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/) an app. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.ping }} - -## project - -{% data reusables.webhooks.project_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project.created }} - -## project_card - -{% data reusables.webhooks.project_card_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_card_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_card.created }} - -## project_column - -{% data reusables.webhooks.project_column_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_column_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_column.created }} - -{% ifversion project-beta-webhooks %} - -## projects_v2_item - -{% note %} - -**Note:** Webhook events for {% data variables.projects.projects_v2 %} are currently in beta and subject to change. To share feedback about {% data variables.projects.projects_v2 %} webhooks with {% data variables.product.product_name %}, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - -{% endnote %} - -Activity related to items in a {% data variables.projects.project_v2 %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[About {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed on the project item. Can be one of `archived`, `converted`, `created`, `edited`, `restored`, `deleted`, or `reordered`. -`projects_v2_item`|`object` | The project item itself. To find more information about the project item, you can use `node_id` (the node ID of the project item) and `project_node_id` (the node ID of the project) to query information in the GraphQL API. For more information, see "[Using the API to manage projects](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." -`changes`|`object` | The changes to the project item. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.projects_v2_item.created }} - -{% endif %} - -## public - -{% data reusables.webhooks.public_short_desc %} -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.public }} - -## pull_request - -{% data reusables.webhooks.pull_request_short_desc %} - -{% ifversion fpt or ghec %} - {% data reusables.pull_requests.merge-queue-beta %} -{% endif %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_webhook_properties %} -{% data reusables.webhooks.pull_request_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -Deliveries for `review_requested` and `review_request_removed` events will have an additional field called `requested_reviewer`. - -{{ webhookPayloadsForCurrentVersion.pull_request.opened }} - -## pull_request_review - -{% data reusables.webhooks.pull_request_review_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review.submitted }} - -## pull_request_review_comment - -{% data reusables.webhooks.pull_request_review_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_comment_webhook_properties %} -{% data reusables.webhooks.pull_request_review_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} - -## pull_request_review_thread - -{% data reusables.webhooks.pull_request_review_thread_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_thread_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }} - -## push - -{% data reusables.webhooks.push_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you push more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`ref`|`string` | The full [`git ref`](/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. -`before`|`string` | The SHA of the most recent commit on `ref` before the push. -`after`|`string` | The SHA of the most recent commit on `ref` after the push. -`created`|`boolean` | Whether this push created the `ref`. -`deleted`|`boolean` | Whether this push deleted the `ref`. -`forced`|`boolean` | Whether this push was a force push of the `ref`. -`head_commit`|`object` | For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag. -`compare`|`string` | 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. -`commits`|`array` | 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.) -`commits[][id]`|`string` | The SHA of the commit. -`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit. -`commits[][message]`|`string` | The commit message. -`commits[][author]`|`object` | The git author of the commit. -`commits[][author][name]`|`string` | The git author's name. -`commits[][author][email]`|`string` | The git author's email address. -`commits[][url]`|`url` | URL that points to the commit API resource. -`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before. -`commits[][added]`|`array` | An array of files added in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were added. -`commits[][modified]`|`array` | An array of files modified by the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were modified. -`commits[][removed]`|`array` | An array of files removed in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were removed. -`pusher` | `object` | The user who pushed the commits. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.push }} - -## release - -{% data reusables.webhooks.release_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.release_webhook_properties %} -{% data reusables.webhooks.release_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.release.published }} - -## repository_dispatch - -This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)" endpoint. - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_dispatch }} - -## repository - -{% data reusables.webhooks.repository_short_desc %} - -### Availability - -- Repository webhooks receive all event types except `deleted` -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted` - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. This can be one of:
  • `created` - A repository is created.
  • `deleted` - A repository is deleted.
  • `archived` - A repository is archived.
  • `unarchived` - A repository is unarchived.
    • {% ifversion ghes or ghae %}
  • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
    • {% endif %}
  • `edited` - A repository's information is edited.
  • `renamed` - A repository is renamed.
  • `transferred` - A repository is transferred.
  • `publicized` - A repository is made public.
  • `privatized` - A repository is made private.
-{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository.publicized }} - -{% ifversion fpt or ghec %} -## repository_import - -{% data reusables.webhooks.repository_import_short_desc %} To receive this event for a personal repository, you must create an empty repository prior to the import. This event can be triggered using either the [GitHub Importer](/articles/importing-a-repository-with-github-importer/) or the [Source imports API](/rest/reference/migrations#source-imports). - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_import_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_import }} - -## repository_vulnerability_alert - -{% data reusables.webhooks.repository_vulnerability_alert_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_vulnerability_alert_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_vulnerability_alert.create }} - -{% endif %} - -{% ifversion ghes or ghec %} - -## secret_scanning_alert - -{% data reusables.webhooks.secret_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `resolved` or `reopened`, the `sender` object will be the user that triggered the event. The `sender` object is empty for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} -{% endif %} - -{% ifversion ghes > 3.4 or ghec or ghae > 3.4 %} -## secret_scanning_alert_location - -{% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_location_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert_location.created }} -{% endif %} - -{% ifversion fpt or ghes or ghec %} -## security_advisory - -Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}. - -The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. The action can be one of `published`, `updated`, `performed`, or `withdrawn` for all new events. -`security_advisory` |`object` | The details of the security advisory, including summary, description, and severity. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_advisory.published }} - -{% endif %} - -{% ifversion ghas-enablement-webhook %} - -## security_and_analysis - -Activity related to enabling or disabling code security and analysis features for a repository or organization. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`changes`|`object` | The changes that were made to the code security and analysis features. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_and_analysis }} - -{% endif %} - -{% ifversion fpt or ghec %} -## sponsorship - -{% data reusables.webhooks.sponsorship_short_desc %} - -You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". - -### Availability - -- Sponsored accounts - -### Webhook payload object - -{% data reusables.webhooks.sponsorship_webhook_properties %} -{% data reusables.webhooks.sponsorship_properties %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone creates a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.created }} - -### Webhook payload example when someone downgrades a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.downgraded }} - -{% endif %} - -## star - -{% data reusables.webhooks.star_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.star_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.star.created }} - -## status - -{% data reusables.webhooks.status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`id` | `integer` | The unique identifier of the status. -`sha`|`string` | The Commit SHA. -`state`|`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`description`|`string` | The optional human-readable description added to the status. -`target_url`|`string` | The optional link added to the status. -`branches`|`array` | An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.status }} - -## team - -{% data reusables.webhooks.team_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of `created`, `deleted`, `edited`, `added_to_repository`, or `removed_from_repository`. -`team` |`object` | The team itself. -`changes`|`object` | The changes to the team if the action was `edited`. -`changes[description][from]` |`string` | The previous version of the description if the action was `edited`. -`changes[name][from]` |`string` | The previous version of the name if the action was `edited`. -`changes[privacy][from]` |`string` | The previous version of the team's privacy if the action was `edited`. -`changes[repository][permissions][from][admin]` | `boolean` | The previous version of the team member's `admin` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][pull]` | `boolean` | The previous version of the team member's `pull` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][push]` | `boolean` | The previous version of the team member's `push` permission on a repository, if the action was `edited`. -`repository`|`object` | The repository that was added or removed from to the team's purview if the action was `added_to_repository`, `removed_from_repository`, or `edited`. For `edited` actions, `repository` also contains the team's new permission levels for the repository. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team.added_to_repository }} - -## team_add - -{% data reusables.webhooks.team_add_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`team`|`object` | The [team](/rest/reference/teams) that was modified. **Note:** Older events may not include this in the payload. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team_add }} - -{% ifversion ghes or ghae %} - -## user - -When a user is `created` or `deleted`. - -### Availability -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.user.created }} - -{% endif %} - -## watch - -{% data reusables.webhooks.watch_short_desc %} - -The event’s actor is the [user](/rest/reference/users) who starred a repository, and the event’s repository is the [repository](/rest/reference/repos) that was starred. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -{% data reusables.webhooks.watch_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.watch.started }} - -{% ifversion fpt or ghes or ghec %} -## workflow_dispatch - -This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the "[Create a workflow dispatch event](/rest/reference/actions/#create-a-workflow-dispatch-event)" endpoint. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -| Key | Type | Description | -|-----|-----|-----| -| `inputs` | `object` | Inputs to the workflow. Each key represents the name of the input while its value represents the value of that input. | -{% data reusables.webhooks.org_desc %} -| `ref` | `string` | The branch or tag from which the workflow was run. | -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} -| `workflow` | `string` | Relative path to the workflow file which contains the workflow. | - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_dispatch }} -{% endif %} - -## workflow_job - -{% data reusables.webhooks.workflow_job_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- Enterprise webhooks - -### Webhook payload object - -{% data reusables.webhooks.workflow_job_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_job }} - -{% ifversion fpt or ghes or ghec %} -## workflow_run - -When a {% data variables.product.prodname_actions %} workflow run is requested or completed. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_run)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions - -### Webhook payload object - -{% data reusables.webhooks.workflow_run_properties %} -{% data reusables.webhooks.workflow_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_run }} -{% endif %} + diff --git a/translations/ja-JP/content/get-started/index.md b/translations/ja-JP/content/get-started/index.md index 293ad5fe2c36..3f00c2bccc5d 100644 --- a/translations/ja-JP/content/get-started/index.md +++ b/translations/ja-JP/content/get-started/index.md @@ -62,11 +62,11 @@ children: - /using-git - /customizing-your-github-workflow - /privacy-on-github -ms.openlocfilehash: 4178e22c506d32b0736305936b56c4c1ff348357 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 7671e605fa3644c4690de6ed16bd9a255bb6b1f6 +ms.sourcegitcommit: 2ecb6ba7d01b2bc9a44ad74a5953b98413216051 ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147580696' +ms.lasthandoff: 11/15/2022 +ms.locfileid: '148165354' --- diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md index b7d50ad27f79..62e9a6540565 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: Organization のメンバー名表示を管理する -intro: Organization のプライベートリポジトリ内において、Organization のメンバーが、コメント作者のプロフィール名を表示できるよう許可することができます。 +title: Managing the display of member names in your organization +intro: You can allow members of your organization to see a comment author's profile name in private repositories in the organization. product: '{% data reusables.gated-features.display-names %}' redirect_from: - /articles/managing-the-display-of-member-names-in-your-organization @@ -14,22 +14,20 @@ topics: - Organizations - Teams shortTitle: Manage display of member names -ms.openlocfilehash: 0a394b40689d95ea37906fef2ddc9b203e2041c3 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147409428' --- -Organization のオーナーは、Organization 内のメンバー名表示を管理できます。 -![コメントに表示されたコメント作者の名前](/assets/images/help/issues/commenter-full-name.png) +Organization owners can manage the display of member names in an organization. -Organization の各メンバーは、自分のプロフィール名を設定で選択します。 詳細については、「[プロフィールをパーソナライズする](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#changing-your-profile-name)」を参照してください。 +![Commenter's profile name displayed in comment](/assets/images/help/issues/commenter-full-name.png) -{% ifversion profile-name-enterprise-setting %}Enterprise 所有者が Enterprise レベルでポリシーを設定している場合、Organization にこの設定を構成できないことがあります。 詳しくは、「[Enterprise でリポジトリ管理ポリシーを適用する](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)」を参照してください。{% endif %} +Changes to the display of usernames within an organization will affect the display of other people's usernames, not your own. Each organization member chooses their own profile name in their settings. For more information, see "[Personalizing your profile](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#changing-your-profile-name)." -{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. [管理者リポジトリのアクセス許可] の下で、 **[プライベートリポジトリでコメント作成者のプロフィール名を表示することをメンバーに許可する]** を選択または選択解除します。 -![プライベートリポジトリ内で、コメント作者のフルネームを表示することをメンバーに許可するためのチェックボックス](/assets/images/help/organizations/allow-members-to-view-full-names.png) -6. **[保存]** をクリックします。 +{% ifversion profile-name-enterprise-setting %} +You may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."{% endif %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.member-privileges %} +5. Under "Admin repository permissions", select or unselect **Allow members to see comment author's profile name in private repositories**. +![Checkbox to allow members to see comment author's full name in private repositories](/assets/images/help/organizations/allow-members-to-view-full-names.png) +6. Click **Save**. diff --git a/translations/ja-JP/content/rest/codespaces/repository-secrets.md b/translations/ja-JP/content/rest/codespaces/repository-secrets.md index 45a2328cbaaa..ed140f20f321 100644 --- a/translations/ja-JP/content/rest/codespaces/repository-secrets.md +++ b/translations/ja-JP/content/rest/codespaces/repository-secrets.md @@ -3,18 +3,19 @@ title: Codespaces リポジトリ シークレット allowTitleToDifferFromFilename: true shortTitle: Repository secrets intro: Codespaces Repository Secrets API を使うと、codespace でユーザーがアクセスできるリポジトリのシークレット (クラウド サービスのアクセス トークンなど) を作成、一覧表示、削除することができます。 +permissions: 'Users with write access to a repository can manage {% data variables.product.prodname_codespaces %} repository secrets.' versions: fpt: '*' ghec: '*' topics: - API miniTocMaxHeadingLevel: 3 -ms.openlocfilehash: d80d75934cc41db2ae12db2df47a41e74627dfef -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 95b3dfaafef598bf05f55d697716eb1036093697 +ms.sourcegitcommit: 9490533fcb7b7d5c16f8fea082a06ee66dd5db8f ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147063979' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148165602' --- ## Codespaces リポジトリ シークレット API について diff --git a/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md b/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md index 4ebc8f8a39da..7401f58a29db 100644 --- a/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md +++ b/translations/ja-JP/data/reusables/actions/actions-audit-events-workflow.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: 1162ab428d4c20f7f0ca4af8c1ec743b30e42852 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 4f04b4395ec12d834bc4d8f350b302c09badea6d +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 10/25/2022 -ms.locfileid: "148109085" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163180" --- | アクション | 説明 |------------------|------------------- diff --git a/translations/ja-JP/data/reusables/actions/minio-gateways-removal.md b/translations/ja-JP/data/reusables/actions/minio-gateways-removal.md deleted file mode 100644 index cae685375d6a..000000000000 --- a/translations/ja-JP/data/reusables/actions/minio-gateways-removal.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -ms.openlocfilehash: b960c6a45b8d934a25c2d7d24e3961fb613ad3d4 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147061547" ---- -{% warning %} - -**警告**: MinIO は MinIO Gateway の削除を発表しています。 2022 年 6 月 1 日以降、現在の MinIO NAS ゲートウェイ実装のサポートとバグ修正は、LTS サポート 契約を結んだ有料のお客様のみが利用できるようになります。 {% data variables.product.prodname_actions %} で引き続き MinIO ゲートウェイを使用する場合は、MinIO LTS のサポートに移行することをお勧めします。 詳細については、minio/minio リポジトリ内の [GCS、Azure、HDFS 用 MinIO Gateway のスケジュールされた削除](https://github.com/minio/minio/issues/14331)に関するページを参照してください。 - -{% endwarning %} diff --git a/translations/ja-JP/data/reusables/audit_log/audit-log-events-workflows.md b/translations/ja-JP/data/reusables/audit_log/audit-log-events-workflows.md index 220429f05e57..b40e4f686d2b 100644 --- a/translations/ja-JP/data/reusables/audit_log/audit-log-events-workflows.md +++ b/translations/ja-JP/data/reusables/audit_log/audit-log-events-workflows.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: 596395b05b2e34b9793107674c8e14bf12d103c8 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 830540b45884edcec609f94aeeaaf5b661a95a51 +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 10/25/2022 -ms.locfileid: "148108880" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163212" --- | アクション | 説明 |--------|------------ diff --git a/translations/ja-JP/data/reusables/dependabot/dependabot-tos.md b/translations/ja-JP/data/reusables/dependabot/dependabot-tos.md index cb992637a8be..fae2510e6cdb 100644 --- a/translations/ja-JP/data/reusables/dependabot/dependabot-tos.md +++ b/translations/ja-JP/data/reusables/dependabot/dependabot-tos.md @@ -1,11 +1,11 @@ --- -ms.openlocfilehash: 30fe5aa7bd3853049757fded26fb3a257f2cd491 -ms.sourcegitcommit: 770ed406ec075528ec9c9695aa4bfdc8c8b25fd3 +ms.openlocfilehash: e71674bb25f77d71366fdc2c3b8ed56d55c81657 +ms.sourcegitcommit: aa67bb5ad7aa6804c5def4390e30adcc7cf96ea1 ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/11/2022 -ms.locfileid: "147884852" +ms.lasthandoff: 11/15/2022 +ms.locfileid: "148165202" --- {% ifversion fpt %} {% data variables.product.prodname_dependabot %} とすべての関連する機能は、[{% data variables.product.prodname_dotcom %} の利用規約](/free-pro-team@latest/github/site-policy/github-terms-of-service)でカバーされています。 -{% elsif ghec %} {% data variables.product.prodname_dependabot %} とすべての関連する機能は、使用許諾契約でカバーされています。 詳細については、「[{% data variables.product.company_short %} Enterprise Customer Terms](https://github.com/enterprise-legal)」を参照してください。 +{% elsif ghec %} {% data variables.product.prodname_dependabot %} とすべての関連する機能は、使用許諾契約でカバーされています。 詳細については、「[{% data variables.product.company_short %} Enterprise Customer Terms](https://github.com/customer-terms)」を参照してください。 {% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/types-of-team-visibility.md b/translations/ja-JP/data/reusables/organizations/types-of-team-visibility.md index a3e65782d600..f407d90a1e88 100644 --- a/translations/ja-JP/data/reusables/organizations/types-of-team-visibility.md +++ b/translations/ja-JP/data/reusables/organizations/types-of-team-visibility.md @@ -1,12 +1,14 @@ --- -ms.openlocfilehash: 4382f549f709e0ecdeb5a578cbfa8bd05bab4ce8 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d +ms.openlocfilehash: 6d6a0678050364e945321a4b9eaf8a06cb731554 +ms.sourcegitcommit: 1671bc6dbc112c6f8db987a6aa706612d464e68e ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/10/2022 -ms.locfileid: "145122141" +ms.lasthandoff: 11/11/2022 +ms.locfileid: "148163016" --- Teamは可視にも秘密にもできます。 - 表示されるチームはあらゆる組織メンバーが[表示し、@mentioned](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)できます。 - 秘密のTeamは、Teamの人と、オーナー権限を持つ人だけに見えます。 秘密のTeamは、外部のパートナーやクライアントとの作業に使われるセンシティブな名前やメンバーを持つTeamを隠すのに適しています。 秘密のチームは親チームの下に入れ子にしたり、子チームを持ったりすることはできません。 + +組織のメンバーではない人は、チームを表示できません。 diff --git a/translations/ja-JP/data/reusables/projects/migrate-project-steps.md b/translations/ja-JP/data/reusables/projects/migrate-project-steps.md index 78d655c3bbf3..54d904216673 100644 --- a/translations/ja-JP/data/reusables/projects/migrate-project-steps.md +++ b/translations/ja-JP/data/reusables/projects/migrate-project-steps.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: ca36d1cc452ae102d0e4183b6d72ce854de57963 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 06ccb7d54079b9cd73a4ce66b02ae3cc9a7b3cf1 +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147423197" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163230" --- 1. 移行するプロジェクトの横にある {% octicon "kebab-horizontal" aria-label="The menu icon" %} をクリックして、メニューを開きます。 1. メニューで、 **[移行]** をクリックします。 diff --git a/translations/ja-JP/data/reusables/support/data-protection-and-privacy.md b/translations/ja-JP/data/reusables/support/data-protection-and-privacy.md index b52c22768a17..56e861518c94 100644 --- a/translations/ja-JP/data/reusables/support/data-protection-and-privacy.md +++ b/translations/ja-JP/data/reusables/support/data-protection-and-privacy.md @@ -1,11 +1,9 @@ --- -ms.openlocfilehash: f233439ae4430b7a7dd0fe3b2c4da87b60f2ab28 -ms.sourcegitcommit: 80842b4e4c500daa051eff0ccd7cde91c2d4bb36 +ms.openlocfilehash: c4ab6a9deea7bf6596f968de26f996392e3d689a +ms.sourcegitcommit: 2ecb6ba7d01b2bc9a44ad74a5953b98413216051 ms.translationtype: HT ms.contentlocale: ja-JP -ms.lasthandoff: 09/12/2022 -ms.locfileid: "145067460" +ms.lasthandoff: 11/15/2022 +ms.locfileid: "148165362" --- -{% data variables.product.prodname_dotcom %} のサポート オファリングを使用する際には、契約条件、[GitHub プライバシーに関する声明](/free-pro-team@latest/github/site-policy/github-privacy-statement)、および [GitHub データ保護契約](/free-pro-team@latest/github/site-policy/github-data-protection-agreement)が適用されます。 契約とは、[GitHub 企業利用規約](/free-pro-team@latest/github/site-policy/github-corporate-terms-of-service)、[GitHub 顧客契約](https://github.com/enterprise-legal)、[またはお客様の Microsoft ボリューム ライセンス契約](/free-pro-team@latest/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing)など、お客様の主要な契約を意味します。 - - +{% data variables.product.prodname_dotcom %} のサポート オファリングを使用する際には、契約条件、[GitHub プライバシーに関する声明](/free-pro-team@latest/github/site-policy/github-privacy-statement)、および [GitHub データ保護契約](/free-pro-team@latest/github/site-policy/github-data-protection-agreement)が適用されます。 契約とは、[GitHub 企業利用規約](/free-pro-team@latest/github/site-policy/github-corporate-terms-of-service)、[GitHub 顧客契約](https://github.com/customer-terms)、[またはお客様の Microsoft ボリューム ライセンス契約](/free-pro-team@latest/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing)など、お客様の主要な契約を意味します。 diff --git a/translations/log/msft-cn-resets.csv b/translations/log/msft-cn-resets.csv index 1f514bbecfa1..ed6763d7317a 100644 --- a/translations/log/msft-cn-resets.csv +++ b/translations/log/msft-cn-resets.csv @@ -54,6 +54,7 @@ translations/zh-CN/content/actions/automating-builds-and-tests/building-and-test translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/deploying-github-advanced-security-in-your-enterprise.md,file deleted because it no longer exists in main translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/overview-of-github-advanced-security-deployment.md,file deleted because it no longer exists in main translations/zh-CN/content/admin/configuration/configuring-your-enterprise/troubleshooting-ssl-errors.md,file deleted because it no longer exists in main +translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,file deleted because it no longer exists in main translations/zh-CN/content/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/index.md,file deleted because it no longer exists in main translations/zh-CN/content/admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/index.md,file deleted because it no longer exists in main translations/zh-CN/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-saml-single-sign-on-recovery-codes.md,file deleted because it no longer exists in main @@ -358,6 +359,7 @@ translations/zh-CN/data/release-notes/enterprise-server/3-2/9.yml,file deleted b translations/zh-CN/data/reusables/actions/enterprise-s3-support-warning.md,file deleted because it no longer exists in main translations/zh-CN/data/reusables/actions/hardware-requirements-3.6.md,file deleted because it no longer exists in main translations/zh-CN/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main +translations/zh-CN/data/reusables/actions/minio-gateways-removal.md,file deleted because it no longer exists in main translations/zh-CN/data/reusables/actions/perform-blob-storage-precheck.md,file deleted because it no longer exists in main translations/zh-CN/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/zh-CN/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main @@ -546,6 +548,7 @@ translations/zh-CN/content/admin/enterprise-management/caching-repositories/conf translations/zh-CN/content/admin/enterprise-management/caching-repositories/index.md,rendering error translations/zh-CN/content/admin/enterprise-management/configuring-clustering/cluster-network-configuration.md,broken liquid tags translations/zh-CN/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md,broken liquid tags +translations/zh-CN/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md,broken liquid tags translations/zh-CN/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md,broken liquid tags translations/zh-CN/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md,broken liquid tags translations/zh-CN/content/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise.md,broken liquid tags @@ -583,6 +586,7 @@ translations/zh-CN/content/admin/identity-and-access-management/using-enterprise translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md,broken liquid tags translations/zh-CN/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/index.md,broken liquid tags translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md,rendering error +translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md,broken liquid tags translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md,broken liquid tags translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/enabling-encrypted-assertions.md,broken liquid tags translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md,broken liquid tags @@ -634,6 +638,7 @@ translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md,broken liquid tags translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md,rendering error translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md,rendering error +translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md,broken liquid tags translations/zh-CN/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md,rendering error translations/zh-CN/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md,rendering error translations/zh-CN/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md,rendering error @@ -690,7 +695,6 @@ translations/zh-CN/content/code-security/code-scanning/automatically-scanning-yo translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error -translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md,broken liquid tags translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md,rendering error @@ -702,7 +706,6 @@ translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scannin translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md,rendering error translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags -translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md,broken liquid tags translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md,rendering error translations/zh-CN/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,rendering error translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md,rendering error @@ -831,7 +834,7 @@ translations/zh-CN/content/discussions/collaborating-with-your-community-using-d translations/zh-CN/content/discussions/guides/finding-your-discussions.md,broken liquid tags translations/zh-CN/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md,broken liquid tags translations/zh-CN/content/discussions/managing-discussions-for-your-community/managing-discussions.md,broken liquid tags -translations/zh-CN/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,broken liquid tags +translations/zh-CN/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,rendering error translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md,broken liquid tags translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md,broken liquid tags translations/zh-CN/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md,broken liquid tags @@ -912,6 +915,7 @@ translations/zh-CN/content/organizations/managing-organization-settings/disablin translations/zh-CN/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md,rendering error translations/zh-CN/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md,rendering error translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,rendering error +translations/zh-CN/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md,rendering error translations/zh-CN/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,broken liquid tags translations/zh-CN/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md,rendering error translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.md,rendering error diff --git a/translations/log/msft-es-resets.csv b/translations/log/msft-es-resets.csv index a287bd5902ff..67eb29fa5560 100644 --- a/translations/log/msft-es-resets.csv +++ b/translations/log/msft-es-resets.csv @@ -55,6 +55,7 @@ translations/es-ES/content/actions/using-jobs/using-a-build-matrix-for-your-jobs translations/es-ES/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/deploying-github-advanced-security-in-your-enterprise.md,file deleted because it no longer exists in main translations/es-ES/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/overview-of-github-advanced-security-deployment.md,file deleted because it no longer exists in main translations/es-ES/content/admin/configuration/configuring-your-enterprise/troubleshooting-ssl-errors.md,file deleted because it no longer exists in main +translations/es-ES/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,file deleted because it no longer exists in main translations/es-ES/content/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,file deleted because it no longer exists in main translations/es-ES/content/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/index.md,file deleted because it no longer exists in main translations/es-ES/content/admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/index.md,file deleted because it no longer exists in main @@ -362,6 +363,7 @@ translations/es-ES/data/reusables/actions/enterprise-s3-support-warning.md,file translations/es-ES/data/reusables/actions/hardware-requirements-3.6.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/jobs/section-using-a-build-matrix-for-your-jobs-strategy.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main +translations/es-ES/data/reusables/actions/minio-gateways-removal.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/perform-blob-storage-precheck.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main @@ -568,6 +570,7 @@ translations/es-ES/content/admin/enterprise-management/caching-repositories/conf translations/es-ES/content/admin/enterprise-management/caching-repositories/index.md,rendering error translations/es-ES/content/admin/enterprise-management/configuring-clustering/cluster-network-configuration.md,broken liquid tags translations/es-ES/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md,broken liquid tags +translations/es-ES/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md,broken liquid tags translations/es-ES/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md,broken liquid tags translations/es-ES/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md,broken liquid tags translations/es-ES/content/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise.md,broken liquid tags @@ -605,6 +608,7 @@ translations/es-ES/content/admin/identity-and-access-management/using-enterprise translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md,rendering error translations/es-ES/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/index.md,broken liquid tags translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md,broken liquid tags +translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md,broken liquid tags translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md,broken liquid tags translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/enabling-encrypted-assertions.md,broken liquid tags translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md,broken liquid tags @@ -655,6 +659,7 @@ translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md,broken liquid tags translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md,rendering error translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md,rendering error +translations/es-ES/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md,broken liquid tags translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md,rendering error translations/es-ES/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md,rendering error translations/es-ES/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md,rendering error @@ -711,19 +716,16 @@ translations/es-ES/content/code-security/code-scanning/automatically-scanning-yo translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md,rendering error translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,rendering error translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error -translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md,broken liquid tags translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md,rendering error translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md,rendering error translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,rendering error translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md,broken liquid tags translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md,rendering error -translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,broken liquid tags translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md,rendering error translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md,rendering error translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags -translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md,broken liquid tags translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md,rendering error translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,rendering error translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md,rendering error @@ -850,7 +852,7 @@ translations/es-ES/content/discussions/collaborating-with-your-community-using-d translations/es-ES/content/discussions/guides/finding-your-discussions.md,broken liquid tags translations/es-ES/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md,broken liquid tags translations/es-ES/content/discussions/managing-discussions-for-your-community/managing-discussions.md,broken liquid tags -translations/es-ES/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,broken liquid tags +translations/es-ES/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,rendering error translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md,broken liquid tags translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md,broken liquid tags translations/es-ES/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md,broken liquid tags @@ -932,6 +934,7 @@ translations/es-ES/content/organizations/managing-organization-settings/disablin translations/es-ES/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md,rendering error translations/es-ES/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md,rendering error translations/es-ES/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,rendering error +translations/es-ES/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md,rendering error translations/es-ES/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,broken liquid tags translations/es-ES/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md,rendering error translations/es-ES/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.md,rendering error diff --git a/translations/log/msft-ja-resets.csv b/translations/log/msft-ja-resets.csv index c7d38282e719..5cf7a7220e73 100644 --- a/translations/log/msft-ja-resets.csv +++ b/translations/log/msft-ja-resets.csv @@ -54,6 +54,7 @@ translations/ja-JP/content/actions/automating-builds-and-tests/building-and-test translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/deploying-github-advanced-security-in-your-enterprise.md,file deleted because it no longer exists in main translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/overview-of-github-advanced-security-deployment.md,file deleted because it no longer exists in main translations/ja-JP/content/admin/configuration/configuring-your-enterprise/troubleshooting-ssl-errors.md,file deleted because it no longer exists in main +translations/ja-JP/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,file deleted because it no longer exists in main translations/ja-JP/content/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,file deleted because it no longer exists in main translations/ja-JP/content/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/changing-authentication-methods.md,file deleted because it no longer exists in main translations/ja-JP/content/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/index.md,file deleted because it no longer exists in main @@ -368,6 +369,7 @@ translations/ja-JP/data/release-notes/enterprise-server/3-2/9.yml,file deleted b translations/ja-JP/data/reusables/actions/enterprise-s3-support-warning.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/actions/hardware-requirements-3.6.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main +translations/ja-JP/data/reusables/actions/minio-gateways-removal.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/actions/perform-blob-storage-precheck.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main @@ -565,6 +567,7 @@ translations/ja-JP/content/admin/enterprise-management/caching-repositories/conf translations/ja-JP/content/admin/enterprise-management/caching-repositories/index.md,rendering error translations/ja-JP/content/admin/enterprise-management/configuring-clustering/cluster-network-configuration.md,broken liquid tags translations/ja-JP/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md,broken liquid tags translations/ja-JP/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md,broken liquid tags translations/ja-JP/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md,broken liquid tags translations/ja-JP/content/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise.md,broken liquid tags @@ -602,6 +605,7 @@ translations/ja-JP/content/admin/identity-and-access-management/using-enterprise translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md,rendering error translations/ja-JP/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/index.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md,broken liquid tags +translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md,broken liquid tags translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md,rendering error translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/enabling-encrypted-assertions.md,broken liquid tags @@ -653,6 +657,7 @@ translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md,broken liquid tags translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md,rendering error translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md,rendering error +translations/ja-JP/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md,broken liquid tags translations/ja-JP/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md,rendering error translations/ja-JP/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md,rendering error translations/ja-JP/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md,rendering error @@ -707,19 +712,16 @@ translations/ja-JP/content/code-security/code-scanning/automatically-scanning-yo translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error -translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md,broken liquid tags translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md,broken liquid tags translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md,rendering error -translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,broken liquid tags translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md,rendering error translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md,rendering error translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags -translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md,broken liquid tags translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md,rendering error translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,rendering error translations/ja-JP/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md,rendering error @@ -846,7 +848,7 @@ translations/ja-JP/content/discussions/collaborating-with-your-community-using-d translations/ja-JP/content/discussions/guides/finding-your-discussions.md,broken liquid tags translations/ja-JP/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md,broken liquid tags translations/ja-JP/content/discussions/managing-discussions-for-your-community/managing-discussions.md,broken liquid tags -translations/ja-JP/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,broken liquid tags +translations/ja-JP/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,rendering error translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md,broken liquid tags translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md,broken liquid tags translations/ja-JP/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md,broken liquid tags @@ -928,6 +930,7 @@ translations/ja-JP/content/organizations/managing-organization-settings/disablin translations/ja-JP/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md,rendering error translations/ja-JP/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md,rendering error translations/ja-JP/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,rendering error +translations/ja-JP/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md,rendering error translations/ja-JP/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,broken liquid tags translations/ja-JP/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md,rendering error translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md,rendering error diff --git a/translations/log/msft-pt-resets.csv b/translations/log/msft-pt-resets.csv index 165cc45f414a..3e1112d9023c 100644 --- a/translations/log/msft-pt-resets.csv +++ b/translations/log/msft-pt-resets.csv @@ -54,6 +54,7 @@ translations/pt-BR/content/actions/automating-builds-and-tests/building-and-test translations/pt-BR/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/deploying-github-advanced-security-in-your-enterprise.md,file deleted because it no longer exists in main translations/pt-BR/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/overview-of-github-advanced-security-deployment.md,file deleted because it no longer exists in main translations/pt-BR/content/admin/configuration/configuring-your-enterprise/troubleshooting-ssl-errors.md,file deleted because it no longer exists in main +translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,file deleted because it no longer exists in main translations/pt-BR/content/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/index.md,file deleted because it no longer exists in main translations/pt-BR/content/admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/index.md,file deleted because it no longer exists in main translations/pt-BR/content/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/index.md,file deleted because it no longer exists in main @@ -360,6 +361,7 @@ translations/pt-BR/data/release-notes/enterprise-server/3-2/9.yml,file deleted b translations/pt-BR/data/reusables/actions/enterprise-s3-support-warning.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/hardware-requirements-3.6.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main +translations/pt-BR/data/reusables/actions/minio-gateways-removal.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/perform-blob-storage-precheck.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main @@ -551,6 +553,7 @@ translations/pt-BR/content/admin/enterprise-management/caching-repositories/conf translations/pt-BR/content/admin/enterprise-management/caching-repositories/index.md,rendering error translations/pt-BR/content/admin/enterprise-management/configuring-clustering/cluster-network-configuration.md,broken liquid tags translations/pt-BR/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md,broken liquid tags +translations/pt-BR/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md,broken liquid tags translations/pt-BR/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md,broken liquid tags translations/pt-BR/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md,broken liquid tags translations/pt-BR/content/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise.md,broken liquid tags @@ -588,6 +591,7 @@ translations/pt-BR/content/admin/identity-and-access-management/using-enterprise translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md,broken liquid tags translations/pt-BR/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/index.md,broken liquid tags translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md,broken liquid tags +translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md,broken liquid tags translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md,broken liquid tags translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/enabling-encrypted-assertions.md,broken liquid tags translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md,broken liquid tags @@ -638,6 +642,7 @@ translations/pt-BR/content/admin/user-management/migrating-data-to-and-from-your translations/pt-BR/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md,broken liquid tags translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md,rendering error translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md,rendering error +translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md,broken liquid tags translations/pt-BR/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md,rendering error translations/pt-BR/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md,rendering error translations/pt-BR/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md,rendering error @@ -833,7 +838,7 @@ translations/pt-BR/content/discussions/collaborating-with-your-community-using-d translations/pt-BR/content/discussions/guides/finding-your-discussions.md,broken liquid tags translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md,broken liquid tags translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-discussions.md,broken liquid tags -translations/pt-BR/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,broken liquid tags +translations/pt-BR/content/discussions/managing-discussions-for-your-community/moderating-discussions.md,rendering error translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md,broken liquid tags translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md,broken liquid tags translations/pt-BR/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md,broken liquid tags diff --git a/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md b/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md index 7186ebf26592..2adee6a3f4e1 100644 --- a/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md +++ b/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md @@ -180,24 +180,35 @@ jobs: ``` {% endraw %} +## Calling a reusable workflow + +You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. + +[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) + +You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} + +{% data reusables.actions.reusable-workflow-calling-syntax %} + +You can call multiple workflows, referencing each in a separate job. + +{% data reusables.actions.uses-keyword-example %} + +### Passing inputs and secrets to a reusable workflow + +{% data reusables.actions.pass-inputs-to-reusable-workflows%} + {% ifversion actions-reusable-workflow-matrix %} -## Using a matrix strategy with a reusable workflow +### Using a matrix strategy with a reusable workflow Jobs using the matrix strategy can call a reusable workflow. A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. For example, you can use a matrix strategy to pass different inputs to a reusable workflow. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)." -### Example matrix strategy with a reusable workflow - -This workflow file references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. The workflow will run three jobs, one for each value in the variable. The workflow file also calls a reusable workflow by using the `uses` keyword. +This example job below calls a reusable workflow and references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. It will run three jobs, one for each value in the variable. {% raw %} ```yaml{:copy} -name: Reusable workflow with matrix strategy - -on: - push: - jobs: ReuseableMatrixJobForDeployment: strategy: @@ -208,25 +219,7 @@ jobs: target: ${{ matrix.target }} ``` {% endraw %} - {% endif %} -## Calling a reusable workflow - -You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. - -[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) - -You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} - -{% data reusables.actions.reusable-workflow-calling-syntax %} - -You can call multiple workflows, referencing each in a separate job. - -{% data reusables.actions.uses-keyword-example %} - -### Passing inputs and secrets to a reusable workflow - -{% data reusables.actions.pass-inputs-to-reusable-workflows%} ### Supported keywords for jobs that call a reusable workflow @@ -238,7 +231,12 @@ When you call a reusable workflow, you can only use the following keywords in th * [`jobs..with.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id) * [`jobs..secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets) * [`jobs..secrets.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id) - {% ifversion actions-inherit-secrets-reusable-workflows %}* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %} +{%- ifversion actions-inherit-secrets-reusable-workflows %} +* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit) +{%- endif %} +{%- ifversion actions-reusable-workflow-matrix %} +* [`jobs..strategy`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategy) +{%- endif %} * [`jobs..needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds) * [`jobs..if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) * [`jobs..permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions) diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index 5b582d063045..e4f70c36cb33 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -33,15 +33,13 @@ During initialization, the enterprise owner will name your enterprise, configure To begin initialization, you will receive an invitation email from {% data variables.product.company_short %}. Before you configure {% data variables.product.prodname_ghe_managed %}, review the following prerequisites. -1. To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." +To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." - {% note %} - - **Note**: {% data reusables.saml.create-a-machine-user %} +{% note %} - {% endnote %} +**Note**: {% data reusables.saml.create-a-machine-user %} -2. {% data reusables.saml.assert-the-administrator-attribute %} +{% endnote %} ## Signing in and naming your enterprise @@ -66,6 +64,7 @@ To configure authentication for {% data variables.product.product_name %}, you m !["Test SAML configuration" button](/assets/images/enterprise/configuration/ae-test-saml-configuration.png) 1. Click **Save**. !["Save" button for IdP configuration](/assets/images/enterprise/configuration/ae-save.png) +1. {% data reusables.saml.assert-the-administrator-attribute %} ## Setting your enterprise policies diff --git a/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md b/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md index 646365453fd2..5d141a81be3e 100644 --- a/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md +++ b/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md @@ -11,12 +11,12 @@ type: overview topics: - Clustering - Enterprise -ms.openlocfilehash: c0f442f455bffea9fd6e7bd225d7c37c0820b4ab -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d +ms.openlocfilehash: 6c009e5d5aa1c2f0b2d3effb3beab2d51f48b070 +ms.sourcegitcommit: ced661bdffebd0f96f6f76db109fbe31983448ba ms.translationtype: HT ms.contentlocale: pt-BR -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145093994' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148167066' --- {% data reusables.enterprise_clustering.clustering-requires-https %} @@ -56,7 +56,7 @@ O clustering permite que os serviços que compõem o {% data variables.product.p - Estabeleça camadas de nós relevantes para a sua organização. Veja esta configuração de exemplo: - Camada de front-end com dois nós e os seguintes serviços: - `web-server` - - `jobs-server` + - `job-server` - `memcache-server` - Camada de banco de dados com dois nós e os seguintes serviços: - `consul-server` diff --git a/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md b/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md index da00b413a21f..d9f9b98dbcbf 100644 --- a/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md +++ b/translations/pt-BR/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md @@ -1,6 +1,6 @@ --- -title: Inicializar o cluster -intro: 'Um cluster do {% data variables.product.prodname_ghe_server %} deve ser configurado com uma licença e inicializado usando o shell administrativo (SSH).' +title: Initializing the cluster +intro: 'A {% data variables.product.prodname_ghe_server %} cluster must be set up with a license and initialized using the administrative shell (SSH).' redirect_from: - /enterprise/admin/clustering/initializing-the-cluster - /enterprise/admin/enterprise-management/initializing-the-cluster @@ -11,111 +11,151 @@ type: how_to topics: - Clustering - Enterprise -ms.openlocfilehash: ea771194e8bf5104707a645c4ee18473ff235153 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146331813' --- {% data reusables.enterprise_clustering.clustering-requires-https %} -## Instalar o {% data variables.product.prodname_ghe_server %} +## Installing {% data variables.product.prodname_ghe_server %} -1. Em cada nó de cluster, provisione e instale o {% data variables.product.prodname_ghe_server %}. Para obter mais informações, confira "[Como configurar uma instância do {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)". -2. Usando o shell administrativo ou o DHCP, configure **apenas** o endereço IP de cada nó. Não altere nenhuma outra configuração. +1. On each cluster node, provision and install {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." +2. Using the administrative shell or DHCP, **only** configure the IP address of each node. Don't configure any other settings. -## Configurar o primeiro nó +## Configuring the first node -1. Conecte-se ao nó que será designado como o primário do MySQL em `cluster.conf`. Para obter mais informações, confira "[Sobre o arquivo de configuração do cluster](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -2. No navegador da Web, acesse `https://:8443/setup/`. -{% data reusables.enterprise_installation.upload-a-license-file %} {% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} {% data reusables.enterprise_installation.instance-will-restart-automatically %} +1. Connect to the node that will be designated as MySQL primary in `cluster.conf`. For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)." +2. In your web browser, visit `https://:8443/setup/`. +{% data reusables.enterprise_installation.upload-a-license-file %} +{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} +{% data reusables.enterprise_installation.instance-will-restart-automatically %} -## Inicializar o cluster +## Initializing the cluster -Para inicializar o cluster, você precisa ter um arquivo de configuração do cluster (`cluster.conf`). Para obter mais informações, confira "[Sobre o arquivo de configuração do cluster](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". +To initialize the cluster, you need a cluster configuration file (`cluster.conf`). For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -1. No primeiro nó que foi configurado, execute `ghe-cluster-config-init`. Essa ação inicializará o cluster caso haja nós no arquivo de configuração que não estão configurados. -2. Execute `ghe-cluster-config-apply`. Isso validará o arquivo `cluster.conf`, aplicará a configuração a cada arquivo de nó e apresentará os serviços configurados em cada nó. +1. From the first node that was configured, run `ghe-cluster-config-init`. This will initialize the cluster if there are nodes in the cluster configuration file that are not configured. +2. Run `ghe-cluster-config-apply`. This will validate the `cluster.conf` file, apply the configuration to each node file and bring up the configured services on each node. -Para verificar o status de um cluster em execução, use o comando `ghe-cluster-status`. +To check the status of a running cluster use the `ghe-cluster-status` command. -## Sobre o arquivo de configuração do cluster +## About the cluster configuration file -O arquivo de configuração do cluster (`cluster.conf`) define os nós no cluster e os serviços que eles executam. -Para obter mais informações, confira "[Sobre os nós de cluster](/enterprise/admin/guides/clustering/about-cluster-nodes)". +The cluster configuration file (`cluster.conf`) defines the nodes in the cluster, and what services they run. +For more information, see "[About cluster nodes](/enterprise/admin/guides/clustering/about-cluster-nodes)." -Este exemplo de `cluster.conf` define um cluster com cinco nós. +This example `cluster.conf` defines a cluster with 11 nodes. - - Dois nós (chamados `ghe-app-node-\*`) executam os serviços `web-server` e `job-server` responsáveis por responder às solicitações do cliente. - - Três nós (chamados `ghe-data-node-\*`) executam os serviços responsáveis pelo armazenamento e pela recuperação dos dados do {% data variables.product.prodname_ghe_server %}. + - Two nodes called `ghes-front-end-node-\*` run services responsible for responding to client requests. + - Three nodes called `ghes-database-node-\*` run services responsible for storage, retrieval, and replication of database data. + - Three nodes called `ghes-search-node-\*` run services responsible for search functionality. + - Three nodes called `ghes-storage-node-\*` run services responsible for storage, retrieval, and replication of data. -Os nomes dos nós podem ser qualquer nome de host válido. Os nomes são definidos como o nome do host de cada nó e serão adicionados a `/etc/hosts` em cada nó, de modo que os nós possam ser resolvidos localmente entre si. +The names of the nodes can be any valid hostname you choose. The names are set as the hostname of each node, and will also be added to `/etc/hosts` on each node, so that the nodes are locally resolvable to each other. -Especifique o primeiro nó de cluster que você configurou como o primário do MySQL por meio de `mysql-server` e `mysql-master`. +Specify the first cluster node you configured as the MySQL primary via `mysql-server` and `mysql-master`. ```ini [cluster] - mysql-master = ghe-data-node-1 - redis-master = ghe-data-node-1 - primary-datacenter = default -[cluster "ghe-app-node-1"] - hostname = ghe-app-node-1 + mysql-master = ghes-database-node-1 + redis-master = ghes-database-node-1 + primary-datacenter = primary +[cluster "ghes-front-end-node-1"] + hostname = ghes-front-end-node-1 ipv4 = 192.168.0.2 # ipv6 = fd12:3456:789a:1::2 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-app-node-2"] - hostname = ghe-app-node-2 + memcache-server = true +[cluster "ghes-front-end-node-2"] + hostname = ghes-front-end-node-2 ipv4 = 192.168.0.3 # ipv6 = fd12:3456:789a:1::3 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-data-node-1"] - hostname = ghe-data-node-1 + memcache-server = true +[cluster "ghes-database-node-1"] + hostname = ghes-database-node-1 ipv4 = 192.168.0.4 # ipv6 = fd12:3456:789a:1::4 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-2"] - hostname = ghe-data-node-2 +[cluster "ghes-database-node-2"] + hostname = ghes-database-node-2 ipv4 = 192.168.0.5 # ipv6 = fd12:3456:789a:1::5 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-3"] - hostname = ghe-data-node-3 +[cluster "ghes-database-node-3"] + hostname = ghes-database-node-3 ipv4 = 192.168.0.6 # ipv6 = fd12:3456:789a:1::6 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true +[cluster "ghes-search-node-1"] + hostname = ghes-search-node-1 + ipv4 = 192.168.0.7 + # ipv6 = fd12:3456:789a:1::7 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-2"] + hostname = ghes-search-node-2 + ipv4 = 192.168.0.8 + # ipv6 = fd12:3456:789a:1::8 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-3"] + hostname = ghes-search-node-3 + ipv4 = 192.168.0.9 + # ipv6 = fd12:3456:789a:1::9 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-storage-node-1"] + hostname = ghes-storage-node-1 + ipv4 = 192.168.0.10 + # ipv6 = fd12:3456:789a:1::10 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true metrics-server = true +[cluster "ghes-storage-node-2"] + hostname = ghes-storage-node-2 + ipv4 = 192.168.0.11 + # ipv6 = fd12:3456:789a:1::11 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true storage-server = true + metrics-server = true +[cluster "ghes-storage-node-3"] + hostname = ghes-storage-node-3 + ipv4 = 192.168.0.12 + # ipv6 = fd12:3456:789a:1::12 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true + metrics-server = true ``` -Crie o arquivo `/data/user/common/cluster.conf` no primeiro nó configurado. Por exemplo, usando `vim`: +Create the file `/data/user/common/cluster.conf` on the configured first node. For example, using `vim`: ```shell ghe-data-node-1:~$ sudo vim /data/user/common/cluster.conf diff --git a/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md deleted file mode 100644 index df4bb84a9ae6..000000000000 --- a/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Habilitar o GitHub Actions com MinIO Gateway para armazenamento NAS -intro: 'Você pode habilitar {% data variables.product.prodname_actions %} no {% data variables.product.prodname_ghe_server %} e usar o Gateway MinIO para armazenamento NAS para armazenar dados gerados por execuções de fluxo de trabalho.' -permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' -versions: - ghes: '*' -type: how_to -topics: - - Actions - - Enterprise - - Infrastructure - - Storage -redirect_from: - - /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage -shortTitle: MinIO Gateway for NAS storage -ms.openlocfilehash: bb738d04d54234704f3278422c1f1ef075956640 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148106866' ---- -{% data reusables.actions.minio-gateways-removal %} - -## Pré-requisitos - -Antes de habilitar {% data variables.product.prodname_actions %}, certifique-se de que você realizou os seguintes passos: - -* Para evitar contenção de recursos no dispositivo, recomendamos que o MinIO seja hospedado separadamente de {% data variables.location.product_location %}. -* Crie seu bucket para armazenar dados de fluxo de trabalho. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} - -{% data reusables.actions.enterprise-common-prereqs %} - -## Habilitar {% data variables.product.prodname_actions %} com MinIO Gateway para armazenamento NAS - -{% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. Em "Armazenamento de Logs e Artefatos", selecione **Amazon S3** e insira os detalhes do bucket de armazenamento: - - * **URL de Serviço da AWS**: a URL para o serviço do MinIO. Por exemplo, `https://my-minio.example:9000`. - * **Bucket da AWS S3**: o nome do bucket S3. - * **Chave de Acesso da AWS S3** e **Chave Secreta da AWS S3**: o `MINIO_ACCESS_KEY` e o `MINIO_SECRET_KEY` usado para sua instância do MinIO. - - ![Botão de opção para selecionar o Amazon S3 Storage e os campos para a configuração do MinIO](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) -1. Em "Armazenamento de Logs e Artefatos", selecione **Forçar estilo de caminho**. - - ![Caixa de seleção para Forçar estilo de caminho](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} - -{% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md b/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md index ac5ef14978d5..a2197da7d974 100644 --- a/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md +++ b/translations/pt-BR/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md @@ -9,14 +9,14 @@ children: - /enabling-github-actions-with-azure-blob-storage - /enabling-github-actions-with-amazon-s3-storage - /enabling-github-actions-with-google-cloud-storage - - /enabling-github-actions-with-minio-gateway-for-nas-storage + - /enabling-github-actions-with-minio-storage - /managing-self-hosted-runners-for-dependabot-updates shortTitle: Enable GitHub Actions -ms.openlocfilehash: 273e03407dd8c3c0a125e2c215a973c88aaf884b -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 56512f06952512bec06068273f8df381a7ba4706 +ms.sourcegitcommit: 8f1801040a84ca9353899a2d1e6782c702aaed0d ms.translationtype: HT ms.contentlocale: pt-BR -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148107854' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148166542' --- diff --git a/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index b4868411b1ce..6d81bf03fffc 100644 --- a/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -131,7 +131,7 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {%- ifversion actions-ghes-gcp-storage %} * Google Cloud Storage {%- endif %} -* S3-compatible MinIO Gateway for NAS +* S3-compatible MinIO cluster {% note %} @@ -141,8 +141,6 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {% endnote %} -{% data reusables.actions.minio-gateways-removal %} - ## Networking considerations {% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." @@ -158,7 +156,7 @@ Follow one of the procedures below to enable {% data variables.product.prodname_ {%- ifversion actions-ghes-gcp-storage %} * [Enabling GitHub Actions with Google Cloud Storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage) {%- endif %} -* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage) +* [Enabling GitHub Actions with MinIO storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage) ## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise diff --git a/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 14b49c525de1..ceebd276ec9b 100644 --- a/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -1,7 +1,7 @@ --- -title: Configurar a autenticação e provisionamento para sua empresa usando o Azure AD +title: Configuring authentication and provisioning for your enterprise using Azure AD shortTitle: Configure with Azure AD -intro: 'Você pode usar um locatário no Azure AD (Azure Active Directory) como um IdP (provedor de identidade) para gerenciar de modo centralizado a autenticação e o provisionamento de usuários de {% data variables.location.product_location %}.' +intro: 'You can use a tenant in Azure Active Directory (Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.location.product_location %}.' permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.' versions: ghae: '*' @@ -17,67 +17,65 @@ redirect_from: - /admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad -ms.openlocfilehash: 10b6fdaa2014836e7a709bc94920dea6331ed030 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148107506' --- -## Sobre autenticação e provisionamento de usuário com Azure AD -O Azure Active Directory (Azure AD) é um serviço da Microsoft que permite gerenciar centralmente as contas de usuários e acessar aplicativos da web. Para obter mais informações, confira [O que é o Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) no Microsoft Docs. +## About authentication and user provisioning with Azure AD -Para gerenciar identidade e acesso para {% data variables.product.product_name %}, você pode usar um inquilino no Azure AD como um IdP de SAML para autenticação. Você também pode configurar o Azure AD para fornecer contas automaticamente e acessar a associação com o SCIM, o que permite criar usuários do {% data variables.product.product_name %} e gerenciar os membros da equipe e da organização por meio do locatário do Azure AD. +Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs. + +To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access membership with SCIM, which allows you to create {% data variables.product.product_name %} users and manage team and organization membership from your Azure AD tenant. {% data reusables.scim.ghes-beta-note %} -Depois de habilitar o SSO de SAML e o SCIM para o {% data variables.product.product_name %} usando o Azure AD, você poderá realizar as ações a seguir no locatário do Azure AD. +After you enable SAML SSO and SCIM for {% data variables.product.product_name %} using Azure AD, you can accomplish the following from your Azure AD tenant. -* Atribuir o aplicativo do {% data variables.product.product_name %} no Azure AD a uma conta de usuário para criar e permitir acesso automaticamente a uma conta de usuário correspondente no {% data variables.product.product_name %}. -* Desatribuir o aplicativo do {% data variables.product.product_name %} de uma conta de usuário no Azure AD para desativar a conta de usuário correspondente no {% data variables.product.product_name %}. -* Atribuir o aplicativo do {% data variables.product.product_name %} a um grupo do IdP no Azure AD para criar e permitir acesso conceder a contas de usuário no {% data variables.product.product_name %} a todos os membros do grupo do IdP. Além disso, o grupo do IdP está disponível no {% data variables.product.product_name %} para conexão com uma equipe e a organização principal. -* Desatribuir o aplicativo do {% data variables.product.product_name %} de um grupo do IdP para desativar as contas de usuário do {% data variables.product.product_name %} de todos os usuários do IdP que tinham acesso somente por meio desse grupo do IdP e remover os usuários da organização principal. O grupo IdP será desconectado de qualquer equipe em {% data variables.product.product_name %}. +* Assign the {% data variables.product.product_name %} application on Azure AD to a user account to automatically create and grant access to a corresponding user account on {% data variables.product.product_name %}. +* Unassign the {% data variables.product.product_name %} application to a user account on Azure AD to deactivate the corresponding user account on {% data variables.product.product_name %}. +* Assign the {% data variables.product.product_name %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.product_name %} for connection to a team and its parent organization. +* Unassign the {% data variables.product.product_name %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. -Para obter mais informações de como gerenciar a identidade e o acesso da empresa em {% data variables.location.product_location %}, confira "[Como gerenciar a identidade e o acesso da empresa](/admin/authentication/managing-identity-and-access-for-your-enterprise)". Para obter mais informações sobre como sincronizar equipes com grupos de IdP, confira "[Como sincronizar uma equipe com um grupo de provedores de identidade](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)". +For more information about managing identity and access for your enterprise on {% data variables.location.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." -## Pré-requisitos +## Prerequisites -- Para configurar o provisionamento de autenticação e usuário para {% data variables.product.product_name %} usando o Azure AD, você deve ter uma conta do Azure AD e um inquilino. Para obter mais informações, confira o [site do Azure AD](https://azure.microsoft.com/free/active-directory) e o [Guia de Início Rápido: Criar um locatário do Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) no Microsoft Docs. +- To configure authentication and user provisioning for {% data variables.product.product_name %} using Azure AD, you must have an Azure AD account and tenant. For more information, see the [Azure AD website](https://azure.microsoft.com/free/active-directory) and [Quickstart: Create an Azure Active Directory tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) in the Microsoft Docs. {%- ifversion scim-for-ghes %} -- {% data reusables.saml.ghes-you-must-configure-saml-sso %} {%- endif %} - -- {% data reusables.saml.assert-the-administrator-attribute %} Para obter mais informações sobre como incluir o atributo `administrator` na declaração SAML do Azure AD, confira [Como personalizar declarações emitidas no token SAML para aplicativos empresariais](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) no Microsoft Docs. +- {% data reusables.saml.ghes-you-must-configure-saml-sso %} +{%- endif %} - {% data reusables.saml.create-a-machine-user %} -## Configurar autenticação e provisionamento de usuário com Azure AD +## Configuring authentication and user provisioning with Azure AD -No locatário do Azure AD, adicione o aplicativo do {% data variables.product.product_name %} e configure o provisionamento. +In your Azure AD tenant, add the application for {% data variables.product.product_name %}, then configure provisioning. {% ifversion ghae %} -1. No Azure AD, adicione {% data variables.enterprise.ae_azure_ad_app_link %} ao locatário e configure o logon único. Para obter mais informações, confira [Tutorial: integração do SSO (logon único) do Azure Active Directory ao {% data variables.product.product_name %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) no Microsoft Docs. +1. In Azure AD, add the {% data variables.enterprise.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.product_name %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs. -1. No {% data variables.product.product_name %}, insira os detalhes do locatário do Azure AD. +1. In {% data variables.product.product_name %}, enter the details for your Azure AD tenant. - {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} - - Se você já configurou SSO de SAML para {% data variables.location.product_location %} usando outro IdP e quer usar o Azure AD, edite a configuração. Para obter mais informações, confira "[Como configurar o logon único do SAML para sua empresa](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)". + - If you've already configured SAML SSO for {% data variables.location.product_location %} using another IdP and you want to use Azure AD instead, you can edit your configuration. For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)." -1. Habilitar provisionamento do usuário em {% data variables.product.product_name %} e configurar provisionamento do usuário no Azure AD. Para obter mais informações, confira "[Como configurar o provisionamento de usuário para sua empresa](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)". +1. Enable user provisioning in {% data variables.product.product_name %} and configure user provisioning in Azure AD. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." {% elsif scim-for-ghes %} -1. No locatário do Azure AD, na barra lateral esquerda, clique em **Provisionamento**. +1. In the Azure AD tenant, in the left sidebar, click **Provisioning**. -1. Em "URL do locatário", digite a URL completa do ponto de extremidade do SCIM em {% data variables.location.product_location %}. Para obter mais informações, confira "[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)" na documentação da API REST. +1. Under "Tenant URL", type the full endpoint URL for SCIM on {% data variables.location.product_location %}. For more information, see "[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)" in the REST API documentation. -1. Em "Token Secreto", digite o {% data variables.product.pat_v1 %} que você criou na etapa 4 de "[Como configurar o provisionamento de usuários com o SCIM na empresa](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)". +1. Under "Secret Token", type the {% data variables.product.pat_v1 %} that you created in step 4 of "[Configuring user provisioning with SCIM for your enterprise](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." -1. Para garantir uma conexão bem-sucedida do Azure AD com a {% data variables.location.product_location %}, clique em **Testar conectividade**. +1. To ensure a successful connection from Azure AD to {% data variables.location.product_location %}, Click **Test Connection**. -1. Depois de garantir uma conexão bem-sucedida, na parte superior da página, clique em **Salvar**. +1. After you ensure a successful connection, at the top of the page, click **Save**. {% endif %} + +1. Assign an enterprise owner for {% data variables.product.product_name %} in Azure AD. The process you should follow depends on whether you configured provisioning. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." + - If you configured provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, assign the enterprise owner role to the user in Azure AD. + - If you did not configure provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs. diff --git a/translations/pt-BR/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/translations/pt-BR/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index 443b6038e140..935cf07d9036 100644 --- a/translations/pt-BR/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/translations/pt-BR/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -24,19 +24,10 @@ This quickstart shows you how to set up MinIO using Docker for use with {% data | MinIO mode | Optimized for | Storage infrastructure required | |----|----|----| | Standalone MinIO (on a single host) | Fast setup | N/A | -| MinIO as a NAS gateway | NAS (Network-attached storage)| NAS devices | | Clustered MinIO (also called Distributed MinIO)| Data security | Storage servers running in a cluster | For more information about your options, see the official [MinIO docs](https://docs.min.io/). -{% warning %} - -**Warning**: MinIO has announced removal of MinIO Gateways. Starting June 1st, 2022, support and bug fixes for the current MinIO NAS Gateway implementation will only be available for paid customers via their LTS support contract. If you want to continue using MinIO Gateways with {% data variables.product.prodname_registry %}, we recommend moving to MinIO LTS support. For more information, see [Scheduled removal of MinIO Gateway for GCS, Azure, HDFS](https://github.com/minio/minio/issues/14331) in the minio/minio repository. - -Other modes of MinIO remain available with standard support. - -{% endwarning %} - ## 2. Install, run, and sign in to MinIO 1. Set up your preferred environment variables for MinIO. @@ -93,18 +84,6 @@ Other modes of MinIO remain available with standard support. For more information, see "[MinIO Docker Quickstart guide](https://docs.min.io/docs/minio-docker-quickstart-guide.html)." - * Run MinIO using Docker as a NAS gateway: - - This setup is useful for deployments where there is already a NAS you want to use as the backup storage for {% data variables.product.prodname_registry %}. - - ```shell - $ docker run -p 9000:9000 \ - -v $MINIO_DIR:/data \ - -e "MINIO_ACCESS_KEY=$MINIO_ACCESS_KEY" \ - -e "MINIO_SECRET_KEY=$MINIO_SECRET_KEY" \ - minio/minio gateway nas /data - ``` - * Run MinIO using Docker as a cluster. This MinIO deployment uses several hosts and MinIO's erasure coding for the strongest data protection. To run MinIO in a cluster mode, see the "[Distributed MinIO Quickstart Guide](https://docs.min.io/docs/distributed-minio-quickstart-guide.html)." ## 3. Create your MinIO bucket for {% data variables.product.prodname_registry %} @@ -124,7 +103,7 @@ Other modes of MinIO remain available with standard support. $ docker run minio/mc BUCKET-NAME ``` - This example can be used for MinIO standalone or MinIO as a NAS gateway. + This example can be used for MinIO standalone. * Clustered deployments example: diff --git a/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md b/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md index 627589975d49..cf62edb6c3eb 100644 --- a/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md +++ b/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md @@ -1,6 +1,6 @@ --- -title: Exibir e gerenciar sessões SAML ativas -intro: É possível exibir e revogar sessões SAML ativas nas configurações de segurança. +title: Viewing and managing your active SAML sessions +intro: You can view and revoke your active SAML sessions in your settings. redirect_from: - /articles/viewing-and-managing-your-active-saml-sessions - /github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions @@ -9,28 +9,31 @@ versions: ghec: '*' topics: - SSO +type: how_to shortTitle: Active SAML sessions -ms.openlocfilehash: ee30f76143ec28a810cd23150d115a3b1cd213c8 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145095806' --- -{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security %} -3. Em "Sessões", você pode ver suas sessões ativas do SAML. - ![Lista de sessões ativas do SAML](/assets/images/help/settings/saml-active-sessions.png) -4. Para ver os detalhes da sessão, clique em **Ver mais**. - ![Botão usado para abrir os detalhes da sessão do SAML](/assets/images/help/settings/saml-expand-session-details.png) -5. Para revogar uma sessão, clique em **Revogar SAML**. - ![Botão usado para revogar uma sessão do SAML](/assets/images/help/settings/saml-revoke-session.png) + +You can view a list of devices that have logged into your account, and revoke any SAML sessions that you don't recognize. + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.sessions %} +1. Under "Web sessions," you can see your active SAML sessions. + + ![Screenshot of the list of active SAML sessions](/assets/images/help/settings/saml-active-sessions.png) + +1. To see the session details, click **See more**. + ![Screenshot of the active SAML sessions with the button to open SAML session details emphasized](/assets/images/help/settings/saml-expand-session-details.png) + +1. To revoke a session, click **Revoke SAML**. + + ![Screenshot of the Session details page with the button to revoke a SAML session emphasized](/assets/images/help/settings/saml-revoke-session.png) {% note %} - **Observação:** quando você revoga uma sessão, remove a autenticação do SAML para essa organização. Para acessar a organização novamente, você precisa fazer logon único por meio do provedor de identidade. Para obter mais informações, confira "[Sobre a autenticação com o SSO do SAML](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)". + **Note:** When you revoke a session, you remove your SAML authentication to that organization. To access the organization again, you will need to single sign-on through your identity provider. For more information, see "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)." {% endnote %} -## Leitura adicional +## Further reading -- "[Sobre a autenticação com o SSO do SAML](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" +- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" diff --git a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/index.md b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/index.md index 3e202cd3272d..b2431aab3349 100644 --- a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/index.md +++ b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/index.md @@ -32,6 +32,7 @@ children: - /githubs-ssh-key-fingerprints - /sudo-mode - /preventing-unauthorized-access + - /viewing-and-managing-your-sessions shortTitle: Account security --- diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md index 0e56df084315..692b4c28a681 100644 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md @@ -20,7 +20,13 @@ shortTitle: GPG verification After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_github_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." -Once you enable GPG verification, it will immediately take effect for all your codespaces. +{% data reusables.codespaces.gpg-in-active-codespaces %} + +{% note %} + +**Note:** If you have linked a dotfiles repository with {% data variables.product.prodname_github_codespaces %}, the Git configuration in your dotfiles may conflict with the configuration that {% data variables.product.prodname_github_codespaces %} requires to sign commits. For more information, see "[Troubleshooting GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces)." + +{% endnote %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} @@ -30,8 +36,4 @@ Once you enable GPG verification, it will immediately take effect for all your c !["Selected repositories" dropdown menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) -{% note %} - -**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, you also must append `-S` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings. - -{% endnote %} +Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, all commits are signed by default in your codespaces. \ No newline at end of file diff --git a/translations/pt-BR/content/codespaces/troubleshooting/index.md b/translations/pt-BR/content/codespaces/troubleshooting/index.md index 2aeca351ebd3..cabc8b2247c8 100644 --- a/translations/pt-BR/content/codespaces/troubleshooting/index.md +++ b/translations/pt-BR/content/codespaces/troubleshooting/index.md @@ -19,6 +19,7 @@ children: - /troubleshooting-dotfiles-for-codespaces - /troubleshooting-port-forwarding-for-github-codespaces - /troubleshooting-github-codespaces-clients + - /troubleshooting-gpg-verification-for-github-codespaces - /working-with-support-for-github-codespaces --- diff --git a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 7f68a7bb8873..fdfc96b3885c 100644 --- a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1,6 +1,6 @@ --- title: Webhook events and payloads -intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.' +intro: 'Learn about when each webhook event occurs and what the payload contains.' product: '{% data reusables.gated-features.enterprise_account_webhooks %}' redirect_from: - /early-access/integrations/webhooks @@ -97,1568 +97,4 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. > } ``` -{% ifversion fpt or ghes > 3.3 or ghae or ghec %} -## branch_protection_rule - -Activity related to a branch protection rule. For more information, see "[About branch protection rules](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`rule` | `object` | The branch protection rule. Includes a `name` and all the [branch protection settings](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. -`changes` | `object` | If the action was `edited`, the changes to the rule. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.branch_protection_rule.edited }} -{% endif %} - -{% ifversion ghes > 3.3 %} -## cache_sync - -A Git ref has been successfully synced to a cache replica. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`cache_location` |`string` | The location of the cache server that has been updated. -`ref` | `string` | The ref that has been updated. -`before` | `string` | The OID of the ref on the cache replica before it was updated. -`after` | `string` | The OID of the ref on the cache replica after the update. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.cache_sync.synced }} -{% endif %} - -## check_run - -{% data reusables.webhooks.check_run_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `created` and `completed` event types in a repository -- Organization webhooks only receive payloads for the `created` and `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_run_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_run.created }} - -## check_suite - -{% data reusables.webhooks.check_suite_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `completed` event types in a repository -- Organization webhooks only receive payloads for the `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_suite_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_suite.completed }} - -## code_scanning_alert - -{% data reusables.webhooks.code_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.code_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `reopened_by_user` or `closed_by_user`, the `sender` object will be the user that triggered the event. The `sender` object is {% ifversion fpt or ghec %}`github`{% elsif ghes or ghae %}`github-enterprise`{% else %}empty{% endif %} for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.code_scanning_alert.reopened }} - -## commit_comment - -{% data reusables.webhooks.commit_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.commit_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.commit_comment.created }} - -{% ifversion ghes < 3.4 %} -## content_reference - -{% data reusables.webhooks.content_reference_short_desc %} - -Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" to create a new content attachment. - -### Availability - -- {% data variables.product.prodname_github_apps %} with the `content_references:write` permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.content_reference.created }} - -{% endif %} -## create - -{% data reusables.webhooks.create_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you create more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.create_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.create }} - -## delete - -{% data reusables.webhooks.delete_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you delete more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.delete_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.delete }} - -{% ifversion fpt or ghec %} -## dependabot_alert - -{% data reusables.webhooks.dependabot_alert_description %} - -### Availability - -{% data reusables.webhooks.dependabot_alert_availability %} - -### Webhook payload object - -{% data reusables.webhooks.dependabot_alert_payload %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.dependabot_alert.fixed }} -{% endif %} - -## deploy_key - -{% data reusables.webhooks.deploy_key_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.deploy_key_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deploy_key.created }} - -## deployment - -{% data reusables.webhooks.deployment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments). -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment }} - -## deployment_status - -{% data reusables.webhooks.deployment_status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment_status` |`object` | The [deployment status](/rest/reference/deployments#list-deployment-statuses). -`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`deployment_status["target_url"]` |`string` | The optional link added to the status. -`deployment_status["description"]`|`string` | The optional human-readable description added to the status. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments) that this status is associated with. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment_status }} - -{% ifversion fpt or ghec %} -## discussion - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a discussion. For more information, see the "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, `deleted`, `pinned`, `unpinned`, `locked`, `unlocked`, `transferred`, `category_changed`, `answered`, `unanswered`, `labeled`, or `unlabeled`. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion.created }} - -## discussion_comment - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a comment in a discussion. For more information, see "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`comment` | `object` | The [`discussion comment`](/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion_comment.created }} -{% endif %} - -{% ifversion ghes or ghae %} - -## enterprise - -{% data reusables.webhooks.enterprise_short_desc %} - -### Availability - -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `anonymous_access_enabled` or `anonymous_access_disabled`. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.enterprise.anonymous_access_enabled }} - -{% endif %} - -## fork - -{% data reusables.webhooks.fork_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.fork_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.fork }} - -## github_app_authorization - -When someone revokes their authorization of a {% data variables.product.prodname_github_app %}, this event occurs. A {% data variables.product.prodname_github_app %} receives this webhook by default and cannot unsubscribe from this event. - -{% data reusables.webhooks.authorization_event %} For details about user-to-server requests, which require {% data variables.product.prodname_github_app %} authorization, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `revoked`. -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.github_app_authorization.revoked }} - -## gollum - -{% data reusables.webhooks.gollum_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.gollum_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.gollum }} - -## installation - -{% data reusables.webhooks.installation_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation.deleted }} - -## installation_repositories - -{% data reusables.webhooks.installation_repositories_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_repositories_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation_repositories.added }} - -## issue_comment - -{% data reusables.webhooks.issue_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_comment_webhook_properties %} -{% data reusables.webhooks.issue_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.issue_comment.created }} - -## issues - -{% data reusables.webhooks.issues_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_webhook_properties %} -{% data reusables.webhooks.issue_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone edits an issue - -{{ webhookPayloadsForCurrentVersion.issues.edited }} - -## label - -{% data reusables.webhooks.label_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Can be `created`, `edited`, or `deleted`. -`label`|`object` | The label that was added. -`changes`|`object`| The changes to the label if the action was `edited`. -`changes[name][from]`|`string` | The previous version of the name if the action was `edited`. -`changes[color][from]`|`string` | The previous version of the color if the action was `edited`. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.label.deleted }} - -{% ifversion fpt or ghec %} -## marketplace_purchase - -Activity related to a GitHub Marketplace purchase. {% data reusables.webhooks.action_type_desc %} For more information, see the "[GitHub Marketplace](/marketplace/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` | `string` | The action performed for a [GitHub Marketplace](https://github.com/marketplace) plan. Can be one of:
  • `purchased` - Someone purchased a GitHub Marketplace plan. The change should take effect on the account immediately.
  • `pending_change` - You will receive the `pending_change` event when someone has downgraded or cancelled a GitHub Marketplace plan to indicate a change will occur on the account. The new plan or cancellation takes effect at the end of the billing cycle. The `cancelled` or `changed` event type will be sent when the billing cycle has ended and the cancellation or new plan should take effect.
  • `pending_change_cancelled` - Someone has cancelled a pending change. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.
  • `changed` - Someone has upgraded or downgraded a GitHub Marketplace plan and the change should take effect on the account immediately.
  • `cancelled` - Someone cancelled a GitHub Marketplace plan and the last billing cycle has ended. The change should take effect on the account immediately.
- -For a detailed description of this payload and the payload for each type of `action`, see [{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/). - -### Webhook payload example when someone purchases the plan - -{{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }} - -{% endif %} - -## member - -{% data reusables.webhooks.member_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.member_webhook_properties %} -{% data reusables.webhooks.member_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.member.added }} - -## membership - -{% data reusables.webhooks.membership_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.membership_properties %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.membership.removed }} - -{% ifversion fpt or ghec %} - -## merge_group - -{% data reusables.pull_requests.merge-queue-beta %} - -Activity related to merge groups in a merge queue. The type of activity is specified in the action property of the payload object. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Merge queues** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Currently, can only be `checks_requested`. -`merge_group`|`object` | The merge group. -`merge_group[head_sha]`|`string` | The SHA of the merge group. -`merge_group[head_ref]`|`string` | The full ref of the merge group. -`merge_group[base_sha]`|`string` | The SHA of the merge group's parent commit. -`merge_group[base_ref]`|`string` | The full ref of the branch the merge group will be merged into. -`merge_group[head_commit]`|`object` | An expanded representation of the `head_sha` commit. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.merge_group.checks_requested }} - -{% endif %} - -## meta - -The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `deleted`. -`hook_id` |`integer` | The id of the modified webhook. -`hook` |`object` | The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.meta.deleted }} - -## milestone - -{% data reusables.webhooks.milestone_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.milestone_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.milestone.created }} - -## organization - -{% data reusables.webhooks.organization_short_desc %} - -### Availability - -{% ifversion ghes or ghae %} -- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} -- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of:{% ifversion ghes or ghae %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`. -`invitation` |`object` | The invitation for the user or email if the action is `member_invited`. -`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.organization.member_added }} - -{% ifversion fpt or ghec %} - -## org_block - -{% data reusables.webhooks.org_block_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`action` | `string` | The action performed. Can be `blocked` or `unblocked`. -`blocked_user` | `object` | Information about the user that was blocked or unblocked. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.org_block.blocked }} - -{% endif %} - -## package - -Activity related to {% data variables.product.prodname_registry %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[Managing packages with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages)" to learn more about {% data variables.product.prodname_registry %}. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.package_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.package.published }} - -## page_build - -{% data reusables.webhooks.page_build_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pages** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`id` | `integer` | The unique identifier of the page build. -`build` | `object` | The [List GitHub Pages builds](/rest/reference/pages#list-github-pages-builds) itself. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.page_build }} - -## ping - -{% data reusables.webhooks.ping_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} receive a ping event with an `app_id` used to register the app - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`zen` | `string` | Random string of GitHub zen. -`hook_id` | `integer` | The ID of the webhook that triggered the ping. -`hook` | `object` | The [webhook configuration](/rest/reference/webhooks#get-a-repository-webhook). -`hook[app_id]` | `integer` | When you register a new {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/) an app. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.ping }} - -## project - -{% data reusables.webhooks.project_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project.created }} - -## project_card - -{% data reusables.webhooks.project_card_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_card_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_card.created }} - -## project_column - -{% data reusables.webhooks.project_column_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_column_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_column.created }} - -{% ifversion project-beta-webhooks %} - -## projects_v2_item - -{% note %} - -**Note:** Webhook events for {% data variables.projects.projects_v2 %} are currently in beta and subject to change. To share feedback about {% data variables.projects.projects_v2 %} webhooks with {% data variables.product.product_name %}, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - -{% endnote %} - -Activity related to items in a {% data variables.projects.project_v2 %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[About {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed on the project item. Can be one of `archived`, `converted`, `created`, `edited`, `restored`, `deleted`, or `reordered`. -`projects_v2_item`|`object` | The project item itself. To find more information about the project item, you can use `node_id` (the node ID of the project item) and `project_node_id` (the node ID of the project) to query information in the GraphQL API. For more information, see "[Using the API to manage projects](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." -`changes`|`object` | The changes to the project item. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.projects_v2_item.created }} - -{% endif %} - -## public - -{% data reusables.webhooks.public_short_desc %} -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.public }} - -## pull_request - -{% data reusables.webhooks.pull_request_short_desc %} - -{% ifversion fpt or ghec %} - {% data reusables.pull_requests.merge-queue-beta %} -{% endif %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_webhook_properties %} -{% data reusables.webhooks.pull_request_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -Deliveries for `review_requested` and `review_request_removed` events will have an additional field called `requested_reviewer`. - -{{ webhookPayloadsForCurrentVersion.pull_request.opened }} - -## pull_request_review - -{% data reusables.webhooks.pull_request_review_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review.submitted }} - -## pull_request_review_comment - -{% data reusables.webhooks.pull_request_review_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_comment_webhook_properties %} -{% data reusables.webhooks.pull_request_review_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} - -## pull_request_review_thread - -{% data reusables.webhooks.pull_request_review_thread_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_thread_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }} - -## push - -{% data reusables.webhooks.push_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you push more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`ref`|`string` | The full [`git ref`](/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. -`before`|`string` | The SHA of the most recent commit on `ref` before the push. -`after`|`string` | The SHA of the most recent commit on `ref` after the push. -`created`|`boolean` | Whether this push created the `ref`. -`deleted`|`boolean` | Whether this push deleted the `ref`. -`forced`|`boolean` | Whether this push was a force push of the `ref`. -`head_commit`|`object` | For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag. -`compare`|`string` | 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. -`commits`|`array` | 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.) -`commits[][id]`|`string` | The SHA of the commit. -`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit. -`commits[][message]`|`string` | The commit message. -`commits[][author]`|`object` | The git author of the commit. -`commits[][author][name]`|`string` | The git author's name. -`commits[][author][email]`|`string` | The git author's email address. -`commits[][url]`|`url` | URL that points to the commit API resource. -`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before. -`commits[][added]`|`array` | An array of files added in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were added. -`commits[][modified]`|`array` | An array of files modified by the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were modified. -`commits[][removed]`|`array` | An array of files removed in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were removed. -`pusher` | `object` | The user who pushed the commits. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.push }} - -## release - -{% data reusables.webhooks.release_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.release_webhook_properties %} -{% data reusables.webhooks.release_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.release.published }} - -## repository_dispatch - -This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)" endpoint. - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_dispatch }} - -## repository - -{% data reusables.webhooks.repository_short_desc %} - -### Availability - -- Repository webhooks receive all event types except `deleted` -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted` - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. This can be one of:
  • `created` - A repository is created.
  • `deleted` - A repository is deleted.
  • `archived` - A repository is archived.
  • `unarchived` - A repository is unarchived.
    • {% ifversion ghes or ghae %}
  • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
    • {% endif %}
  • `edited` - A repository's information is edited.
  • `renamed` - A repository is renamed.
  • `transferred` - A repository is transferred.
  • `publicized` - A repository is made public.
  • `privatized` - A repository is made private.
-{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository.publicized }} - -{% ifversion fpt or ghec %} -## repository_import - -{% data reusables.webhooks.repository_import_short_desc %} To receive this event for a personal repository, you must create an empty repository prior to the import. This event can be triggered using either the [GitHub Importer](/articles/importing-a-repository-with-github-importer/) or the [Source imports API](/rest/reference/migrations#source-imports). - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_import_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_import }} - -## repository_vulnerability_alert - -{% data reusables.webhooks.repository_vulnerability_alert_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_vulnerability_alert_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_vulnerability_alert.create }} - -{% endif %} - -{% ifversion ghes or ghec %} - -## secret_scanning_alert - -{% data reusables.webhooks.secret_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `resolved` or `reopened`, the `sender` object will be the user that triggered the event. The `sender` object is empty for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} -{% endif %} - -{% ifversion ghes > 3.4 or ghec or ghae > 3.4 %} -## secret_scanning_alert_location - -{% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_location_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert_location.created }} -{% endif %} - -{% ifversion fpt or ghes or ghec %} -## security_advisory - -Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}. - -The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. The action can be one of `published`, `updated`, `performed`, or `withdrawn` for all new events. -`security_advisory` |`object` | The details of the security advisory, including summary, description, and severity. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_advisory.published }} - -{% endif %} - -{% ifversion ghas-enablement-webhook %} - -## security_and_analysis - -Activity related to enabling or disabling code security and analysis features for a repository or organization. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`changes`|`object` | The changes that were made to the code security and analysis features. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_and_analysis }} - -{% endif %} - -{% ifversion fpt or ghec %} -## sponsorship - -{% data reusables.webhooks.sponsorship_short_desc %} - -You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". - -### Availability - -- Sponsored accounts - -### Webhook payload object - -{% data reusables.webhooks.sponsorship_webhook_properties %} -{% data reusables.webhooks.sponsorship_properties %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone creates a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.created }} - -### Webhook payload example when someone downgrades a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.downgraded }} - -{% endif %} - -## star - -{% data reusables.webhooks.star_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.star_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.star.created }} - -## status - -{% data reusables.webhooks.status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`id` | `integer` | The unique identifier of the status. -`sha`|`string` | The Commit SHA. -`state`|`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`description`|`string` | The optional human-readable description added to the status. -`target_url`|`string` | The optional link added to the status. -`branches`|`array` | An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.status }} - -## team - -{% data reusables.webhooks.team_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of `created`, `deleted`, `edited`, `added_to_repository`, or `removed_from_repository`. -`team` |`object` | The team itself. -`changes`|`object` | The changes to the team if the action was `edited`. -`changes[description][from]` |`string` | The previous version of the description if the action was `edited`. -`changes[name][from]` |`string` | The previous version of the name if the action was `edited`. -`changes[privacy][from]` |`string` | The previous version of the team's privacy if the action was `edited`. -`changes[repository][permissions][from][admin]` | `boolean` | The previous version of the team member's `admin` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][pull]` | `boolean` | The previous version of the team member's `pull` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][push]` | `boolean` | The previous version of the team member's `push` permission on a repository, if the action was `edited`. -`repository`|`object` | The repository that was added or removed from to the team's purview if the action was `added_to_repository`, `removed_from_repository`, or `edited`. For `edited` actions, `repository` also contains the team's new permission levels for the repository. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team.added_to_repository }} - -## team_add - -{% data reusables.webhooks.team_add_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`team`|`object` | The [team](/rest/reference/teams) that was modified. **Note:** Older events may not include this in the payload. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team_add }} - -{% ifversion ghes or ghae %} - -## user - -When a user is `created` or `deleted`. - -### Availability -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.user.created }} - -{% endif %} - -## watch - -{% data reusables.webhooks.watch_short_desc %} - -The event’s actor is the [user](/rest/reference/users) who starred a repository, and the event’s repository is the [repository](/rest/reference/repos) that was starred. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -{% data reusables.webhooks.watch_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.watch.started }} - -{% ifversion fpt or ghes or ghec %} -## workflow_dispatch - -This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the "[Create a workflow dispatch event](/rest/reference/actions/#create-a-workflow-dispatch-event)" endpoint. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -| Key | Type | Description | -|-----|-----|-----| -| `inputs` | `object` | Inputs to the workflow. Each key represents the name of the input while its value represents the value of that input. | -{% data reusables.webhooks.org_desc %} -| `ref` | `string` | The branch or tag from which the workflow was run. | -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} -| `workflow` | `string` | Relative path to the workflow file which contains the workflow. | - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_dispatch }} -{% endif %} - -## workflow_job - -{% data reusables.webhooks.workflow_job_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- Enterprise webhooks - -### Webhook payload object - -{% data reusables.webhooks.workflow_job_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_job }} - -{% ifversion fpt or ghes or ghec %} -## workflow_run - -When a {% data variables.product.prodname_actions %} workflow run is requested or completed. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_run)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions - -### Webhook payload object - -{% data reusables.webhooks.workflow_run_properties %} -{% data reusables.webhooks.workflow_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_run }} -{% endif %} + diff --git a/translations/pt-BR/content/get-started/index.md b/translations/pt-BR/content/get-started/index.md index a2b350c41b6b..f6f4e31f635f 100644 --- a/translations/pt-BR/content/get-started/index.md +++ b/translations/pt-BR/content/get-started/index.md @@ -62,11 +62,11 @@ children: - /using-git - /customizing-your-github-workflow - /privacy-on-github -ms.openlocfilehash: 4178e22c506d32b0736305936b56c4c1ff348357 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 7671e605fa3644c4690de6ed16bd9a255bb6b1f6 +ms.sourcegitcommit: 2ecb6ba7d01b2bc9a44ad74a5953b98413216051 ms.translationtype: HT ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147580692' +ms.lasthandoff: 11/15/2022 +ms.locfileid: '148165350' --- diff --git a/translations/pt-BR/content/rest/codespaces/repository-secrets.md b/translations/pt-BR/content/rest/codespaces/repository-secrets.md index 64f29d8221a5..b29f7282694c 100644 --- a/translations/pt-BR/content/rest/codespaces/repository-secrets.md +++ b/translations/pt-BR/content/rest/codespaces/repository-secrets.md @@ -3,18 +3,19 @@ title: Segredos do repositório de codespaces allowTitleToDifferFromFilename: true shortTitle: Repository secrets intro: 'A API Segredos do repositório de codespaces permite que o usuário crie, liste e exclua segredos (como tokens de acesso de serviços de nuvem) dos repositórios aos quais tem acesso em um codespace.' +permissions: 'Users with write access to a repository can manage {% data variables.product.prodname_codespaces %} repository secrets.' versions: fpt: '*' ghec: '*' topics: - API miniTocMaxHeadingLevel: 3 -ms.openlocfilehash: d80d75934cc41db2ae12db2df47a41e74627dfef -ms.sourcegitcommit: 5f9527483381cfb1e41f2322f67c80554750a47d +ms.openlocfilehash: 95b3dfaafef598bf05f55d697716eb1036093697 +ms.sourcegitcommit: 9490533fcb7b7d5c16f8fea082a06ee66dd5db8f ms.translationtype: HT ms.contentlocale: pt-BR -ms.lasthandoff: 09/12/2022 -ms.locfileid: '147063974' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148165598' --- ## Sobre a API de segredos do repositório de codespaces diff --git a/translations/pt-BR/data/reusables/actions/minio-gateways-removal.md b/translations/pt-BR/data/reusables/actions/minio-gateways-removal.md deleted file mode 100644 index 5c868997769f..000000000000 --- a/translations/pt-BR/data/reusables/actions/minio-gateways-removal.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -ms.openlocfilehash: b960c6a45b8d934a25c2d7d24e3961fb613ad3d4 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147061543" ---- -{% warning %} - -**Aviso**: o MinIO anunciou a remoção de Gateways MinIO. A partir de 1º de junho de 2022, as correções de suporte e bug para a implementação atual do Gateway do MinIO NAS estarão disponíveis somente para clientes pagos por meio de seu contrato de suporte LTS. Se você quiser continuar usando gateways MinIO com {% data variables.product.prodname_actions %}, recomendamos migrar para o suporte do MinIO LTS. Para saber mais, confira a [remoção agendada do Gateway do MinIO para GCS, Azure, HDFS](https://github.com/minio/minio/issues/14331) no repositório minio/minio. - -{% endwarning %} diff --git a/translations/pt-BR/data/reusables/dependabot/dependabot-tos.md b/translations/pt-BR/data/reusables/dependabot/dependabot-tos.md index 09732088f3c7..a9c58cfc438c 100644 --- a/translations/pt-BR/data/reusables/dependabot/dependabot-tos.md +++ b/translations/pt-BR/data/reusables/dependabot/dependabot-tos.md @@ -1,11 +1,11 @@ --- -ms.openlocfilehash: 30fe5aa7bd3853049757fded26fb3a257f2cd491 -ms.sourcegitcommit: 770ed406ec075528ec9c9695aa4bfdc8c8b25fd3 +ms.openlocfilehash: e71674bb25f77d71366fdc2c3b8ed56d55c81657 +ms.sourcegitcommit: aa67bb5ad7aa6804c5def4390e30adcc7cf96ea1 ms.translationtype: HT ms.contentlocale: pt-BR -ms.lasthandoff: 09/11/2022 -ms.locfileid: "147884848" +ms.lasthandoff: 11/15/2022 +ms.locfileid: "148165198" --- {% ifversion fpt %} O {% data variables.product.prodname_dependabot %} e todos os recursos relacionados são cobertos pelos [Termos de Serviço do {% data variables.product.prodname_dotcom %}](/free-pro-team@latest/github/site-policy/github-terms-of-service). -{% elsif ghec %} O {% data variables.product.prodname_dependabot %} e todos os recursos relacionados são cobertos pelo contrato de licença. Para obter mais informações, confira "[ Termos do Cliente Enterprise do {% data variables.product.company_short %}](https://github.com/enterprise-legal)". +{% elsif ghec %} O {% data variables.product.prodname_dependabot %} e todos os recursos relacionados são cobertos pelo contrato de licença. Para obter mais informações, confira "[ Termos do Cliente Enterprise do {% data variables.product.company_short %}](https://github.com/customer-terms)". {% endif %} diff --git a/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md b/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md index 7186ebf26592..2adee6a3f4e1 100644 --- a/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md +++ b/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md @@ -180,24 +180,35 @@ jobs: ``` {% endraw %} +## Calling a reusable workflow + +You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. + +[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) + +You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} + +{% data reusables.actions.reusable-workflow-calling-syntax %} + +You can call multiple workflows, referencing each in a separate job. + +{% data reusables.actions.uses-keyword-example %} + +### Passing inputs and secrets to a reusable workflow + +{% data reusables.actions.pass-inputs-to-reusable-workflows%} + {% ifversion actions-reusable-workflow-matrix %} -## Using a matrix strategy with a reusable workflow +### Using a matrix strategy with a reusable workflow Jobs using the matrix strategy can call a reusable workflow. A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. For example, you can use a matrix strategy to pass different inputs to a reusable workflow. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)." -### Example matrix strategy with a reusable workflow - -This workflow file references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. The workflow will run three jobs, one for each value in the variable. The workflow file also calls a reusable workflow by using the `uses` keyword. +This example job below calls a reusable workflow and references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. It will run three jobs, one for each value in the variable. {% raw %} ```yaml{:copy} -name: Reusable workflow with matrix strategy - -on: - push: - jobs: ReuseableMatrixJobForDeployment: strategy: @@ -208,25 +219,7 @@ jobs: target: ${{ matrix.target }} ``` {% endraw %} - {% endif %} -## Calling a reusable workflow - -You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. - -[`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) - -You reference reusable workflow files using {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}one of the following syntaxes:{% else %}the syntax:{% endif %} - -{% data reusables.actions.reusable-workflow-calling-syntax %} - -You can call multiple workflows, referencing each in a separate job. - -{% data reusables.actions.uses-keyword-example %} - -### Passing inputs and secrets to a reusable workflow - -{% data reusables.actions.pass-inputs-to-reusable-workflows%} ### Supported keywords for jobs that call a reusable workflow @@ -238,7 +231,12 @@ When you call a reusable workflow, you can only use the following keywords in th * [`jobs..with.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id) * [`jobs..secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets) * [`jobs..secrets.`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id) - {% ifversion actions-inherit-secrets-reusable-workflows %}* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %} +{%- ifversion actions-inherit-secrets-reusable-workflows %} +* [`jobs..secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit) +{%- endif %} +{%- ifversion actions-reusable-workflow-matrix %} +* [`jobs..strategy`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategy) +{%- endif %} * [`jobs..needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds) * [`jobs..if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) * [`jobs..permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions) diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index 5b582d063045..e4f70c36cb33 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -33,15 +33,13 @@ During initialization, the enterprise owner will name your enterprise, configure To begin initialization, you will receive an invitation email from {% data variables.product.company_short %}. Before you configure {% data variables.product.prodname_ghe_managed %}, review the following prerequisites. -1. To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." +To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." - {% note %} - - **Note**: {% data reusables.saml.create-a-machine-user %} +{% note %} - {% endnote %} +**Note**: {% data reusables.saml.create-a-machine-user %} -2. {% data reusables.saml.assert-the-administrator-attribute %} +{% endnote %} ## Signing in and naming your enterprise @@ -66,6 +64,7 @@ To configure authentication for {% data variables.product.product_name %}, you m !["Test SAML configuration" button](/assets/images/enterprise/configuration/ae-test-saml-configuration.png) 1. Click **Save**. !["Save" button for IdP configuration](/assets/images/enterprise/configuration/ae-save.png) +1. {% data reusables.saml.assert-the-administrator-attribute %} ## Setting your enterprise policies diff --git a/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md b/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md index e80647ac3ee9..2e3d5ce2c690 100644 --- a/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md +++ b/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md @@ -11,12 +11,12 @@ type: overview topics: - Clustering - Enterprise -ms.openlocfilehash: c0f442f455bffea9fd6e7bd225d7c37c0820b4ab -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d +ms.openlocfilehash: 6c009e5d5aa1c2f0b2d3effb3beab2d51f48b070 +ms.sourcegitcommit: ced661bdffebd0f96f6f76db109fbe31983448ba ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145098088' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148167068' --- {% data reusables.enterprise_clustering.clustering-requires-https %} @@ -56,7 +56,7 @@ ms.locfileid: '145098088' - 建立对您的组织有意义的节点层。 配置示例： - 具有两个节点和以下服务的前端层： - `web-server` - - `jobs-server` + - `job-server` - `memcache-server` - 具有三个节点和以下服务的数据库层： - `consul-server` diff --git a/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md b/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md index a126f26611fc..d9f9b98dbcbf 100644 --- a/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md +++ b/translations/zh-CN/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md @@ -1,6 +1,6 @@ --- -title: 初始化集群 -intro: '{% data variables.product.prodname_ghe_server %} 集群必须使用许可进行设置，并使用管理 shell (SSH) 进行初始化。' +title: Initializing the cluster +intro: 'A {% data variables.product.prodname_ghe_server %} cluster must be set up with a license and initialized using the administrative shell (SSH).' redirect_from: - /enterprise/admin/clustering/initializing-the-cluster - /enterprise/admin/enterprise-management/initializing-the-cluster @@ -11,111 +11,151 @@ type: how_to topics: - Clustering - Enterprise -ms.openlocfilehash: ea771194e8bf5104707a645c4ee18473ff235153 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: zh-CN -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146331814' --- {% data reusables.enterprise_clustering.clustering-requires-https %} -## 安装 {% data variables.product.prodname_ghe_server %} +## Installing {% data variables.product.prodname_ghe_server %} -1. 在每个集群节点上，提供并安装 {% data variables.product.prodname_ghe_server %}。 有关详细信息，请参阅“[设置 {% data variables.product.prodname_ghe_server %} 实例](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)”。 -2. 使用管理 shell 或 DHCP，仅配置每个节点的 IP 地址。 不要配置任何其他设置。 +1. On each cluster node, provision and install {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." +2. Using the administrative shell or DHCP, **only** configure the IP address of each node. Don't configure any other settings. -## 配置第一个节点 +## Configuring the first node -1. 连接到将在 `cluster.conf` 中指定为 MySQL 主要节点的节点。 有关详细信息，请参阅“[关于群集配置文件](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)”。 -2. 在 Web 浏览器中，访问 `https://:8443/setup/`。 -{% data reusables.enterprise_installation.upload-a-license-file %} {% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} {% data reusables.enterprise_installation.instance-will-restart-automatically %} +1. Connect to the node that will be designated as MySQL primary in `cluster.conf`. For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)." +2. In your web browser, visit `https://:8443/setup/`. +{% data reusables.enterprise_installation.upload-a-license-file %} +{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} +{% data reusables.enterprise_installation.instance-will-restart-automatically %} -## 初始化集群 +## Initializing the cluster -若要初始化群集，需要群集配置文件 (`cluster.conf`)。 有关详细信息，请参阅“[关于群集配置文件](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)”。 +To initialize the cluster, you need a cluster configuration file (`cluster.conf`). For more information, see "[About the cluster configuration file](/enterprise/admin/guides/clustering/initializing-the-cluster/#about-the-cluster-configuration-file)". -1. 从配置的第一个节点开始，运行 `ghe-cluster-config-init`。 如果集群配置文件中存在未配置的节点，此操作会初始化集群。 -2. 运行 `ghe-cluster-config-apply`。 这将验证 `cluster.conf` 文件、将配置应用于每个节点文件，并调出每个节点上已配置的服务。 +1. From the first node that was configured, run `ghe-cluster-config-init`. This will initialize the cluster if there are nodes in the cluster configuration file that are not configured. +2. Run `ghe-cluster-config-apply`. This will validate the `cluster.conf` file, apply the configuration to each node file and bring up the configured services on each node. -若要检查正在运行的群集的状态，请使用 `ghe-cluster-status` 命令。 +To check the status of a running cluster use the `ghe-cluster-status` command. -## 关于集群配置文件 +## About the cluster configuration file -群集配置文件 (`cluster.conf`) 会定义群集中的节点及其运行的服务。 -有关详细信息，请参阅“[关于群集节点](/enterprise/admin/guides/clustering/about-cluster-nodes)”。 +The cluster configuration file (`cluster.conf`) defines the nodes in the cluster, and what services they run. +For more information, see "[About cluster nodes](/enterprise/admin/guides/clustering/about-cluster-nodes)." -此示例 `cluster.conf` 定义具有五个节点的群集。 +This example `cluster.conf` defines a cluster with 11 nodes. - - 两个节点（称为 `ghe-app-node-\*`）运行负责响应客户端请求的 `web-server` 和 `job-server` 服务。 - - 三个节点（称为 `ghe-data-node-\*`）运行负责存储和检索 {% data variables.product.prodname_ghe_server %} 数据的服务。 + - Two nodes called `ghes-front-end-node-\*` run services responsible for responding to client requests. + - Three nodes called `ghes-database-node-\*` run services responsible for storage, retrieval, and replication of database data. + - Three nodes called `ghes-search-node-\*` run services responsible for search functionality. + - Three nodes called `ghes-storage-node-\*` run services responsible for storage, retrieval, and replication of data. -节点的名称可以是您选择的任何有效主机名。 名称被设置为每个节点的主机名，并且还将添加到每个节点上的 `/etc/hosts` 中，以便节点可以在本地相互解析。 +The names of the nodes can be any valid hostname you choose. The names are set as the hostname of each node, and will also be added to `/etc/hosts` on each node, so that the nodes are locally resolvable to each other. -通过 `mysql-server` 和 `mysql-master` 指定你配置为 MySQL 主要节点的第一个集群节点。 +Specify the first cluster node you configured as the MySQL primary via `mysql-server` and `mysql-master`. ```ini [cluster] - mysql-master = ghe-data-node-1 - redis-master = ghe-data-node-1 - primary-datacenter = default -[cluster "ghe-app-node-1"] - hostname = ghe-app-node-1 + mysql-master = ghes-database-node-1 + redis-master = ghes-database-node-1 + primary-datacenter = primary +[cluster "ghes-front-end-node-1"] + hostname = ghes-front-end-node-1 ipv4 = 192.168.0.2 # ipv6 = fd12:3456:789a:1::2 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-app-node-2"] - hostname = ghe-app-node-2 + memcache-server = true +[cluster "ghes-front-end-node-2"] + hostname = ghes-front-end-node-2 ipv4 = 192.168.0.3 # ipv6 = fd12:3456:789a:1::3 + consul-datacenter = primary + datacenter = primary web-server = true job-server = true -[cluster "ghe-data-node-1"] - hostname = ghe-data-node-1 + memcache-server = true +[cluster "ghes-database-node-1"] + hostname = ghes-database-node-1 ipv4 = 192.168.0.4 # ipv6 = fd12:3456:789a:1::4 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-2"] - hostname = ghe-data-node-2 +[cluster "ghes-database-node-2"] + hostname = ghes-database-node-2 ipv4 = 192.168.0.5 # ipv6 = fd12:3456:789a:1::5 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true - metrics-server = true - storage-server = true -[cluster "ghe-data-node-3"] - hostname = ghe-data-node-3 +[cluster "ghes-database-node-3"] + hostname = ghes-database-node-3 ipv4 = 192.168.0.6 # ipv6 = fd12:3456:789a:1::6 + consul-datacenter = primary + datacenter = primary consul-server = true - consul-datacenter = default - git-server = true - pages-server = true mysql-server = true - elasticsearch-server = true redis-server = true - memcache-server = true +[cluster "ghes-search-node-1"] + hostname = ghes-search-node-1 + ipv4 = 192.168.0.7 + # ipv6 = fd12:3456:789a:1::7 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-2"] + hostname = ghes-search-node-2 + ipv4 = 192.168.0.8 + # ipv6 = fd12:3456:789a:1::8 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-search-node-3"] + hostname = ghes-search-node-3 + ipv4 = 192.168.0.9 + # ipv6 = fd12:3456:789a:1::9 + consul-datacenter = primary + datacenter = primary + elasticsearch-server = true +[cluster "ghes-storage-node-1"] + hostname = ghes-storage-node-1 + ipv4 = 192.168.0.10 + # ipv6 = fd12:3456:789a:1::10 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true metrics-server = true +[cluster "ghes-storage-node-2"] + hostname = ghes-storage-node-2 + ipv4 = 192.168.0.11 + # ipv6 = fd12:3456:789a:1::11 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true storage-server = true + metrics-server = true +[cluster "ghes-storage-node-3"] + hostname = ghes-storage-node-3 + ipv4 = 192.168.0.12 + # ipv6 = fd12:3456:789a:1::12 + consul-datacenter = primary + datacenter = primary + git-server = true + pages-server = true + storage-server = true + metrics-server = true ``` -在配置的第一个节点上创建文件 `/data/user/common/cluster.conf`。 例如，使用 `vim`： +Create the file `/data/user/common/cluster.conf` on the configured first node. For example, using `vim`: ```shell ghe-data-node-1:~$ sudo vim /data/user/common/cluster.conf diff --git a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md deleted file mode 100644 index 23677d66a0d4..000000000000 --- a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: 使用 MinIO Gateway for NAS 存储启用 GitHub Actions -intro: '可以在 {% data variables.product.prodname_ghe_server %} 上启用 {% data variables.product.prodname_actions %}，并使用 MinIO Gateway for NAS 存储来存储工作流运行生成的数据。' -permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' -versions: - ghes: '*' -type: how_to -topics: - - Actions - - Enterprise - - Infrastructure - - Storage -redirect_from: - - /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage -shortTitle: MinIO Gateway for NAS storage -ms.openlocfilehash: bb738d04d54234704f3278422c1f1ef075956640 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: zh-CN -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148106867' ---- -{% data reusables.actions.minio-gateways-removal %} - -## 先决条件 - -在启用 {% data variables.product.prodname_actions %} 之前，请确保您已完成以下步骤： - -* 为避免设备上的资源争用，我们建议将 MinIO 与 {% data variables.location.product_location %} 分开托管。 -* 创建用于存储工作流数据的桶。 {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} - -{% data reusables.actions.enterprise-common-prereqs %} - -## 使用 MinIO Gateway for NAS 存储启用 {% data variables.product.prodname_actions %} - -{% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -1. 在“项目和日志存储”下，选择“Amazon S3”，然后输入存储桶的详细信息： - - * AWS 服务 URL：MinIO 服务的 URL。 例如 `https://my-minio.example:9000`。 - * AWS S3 存储桶：S3 存储桶的名称。 - * AWS S3 访问密钥和 AWS S3 密钥：用于 MinIO 实例的 `MINIO_ACCESS_KEY` 和 `MINIO_SECRET_KEY` 。 - - ![用于选择 Amazon S3 存储的单选按钮和用于 MinIO 配置的字段](/assets/images/enterprise/management-console/actions-minio-s3-storage.png) -1. 在“项目和日志存储”下，选择“强制路径样式”。 - - ![“强制实施路径样式”复选框](/assets/images/enterprise/management-console/actions-minio-force-path-style.png) {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} - -{% data reusables.actions.enterprise-postinstall-nextsteps %} diff --git a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md index da5758bbe58a..32fd0544c6a3 100644 --- a/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md +++ b/translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md @@ -9,14 +9,14 @@ children: - /enabling-github-actions-with-azure-blob-storage - /enabling-github-actions-with-amazon-s3-storage - /enabling-github-actions-with-google-cloud-storage - - /enabling-github-actions-with-minio-gateway-for-nas-storage + - /enabling-github-actions-with-minio-storage - /managing-self-hosted-runners-for-dependabot-updates shortTitle: Enable GitHub Actions -ms.openlocfilehash: 273e03407dd8c3c0a125e2c215a973c88aaf884b -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 56512f06952512bec06068273f8df381a7ba4706 +ms.sourcegitcommit: 8f1801040a84ca9353899a2d1e6782c702aaed0d ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148108108' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148166543' --- diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index b4868411b1ce..6d81bf03fffc 100644 --- a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -131,7 +131,7 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {%- ifversion actions-ghes-gcp-storage %} * Google Cloud Storage {%- endif %} -* S3-compatible MinIO Gateway for NAS +* S3-compatible MinIO cluster {% note %} @@ -141,8 +141,6 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro {% endnote %} -{% data reusables.actions.minio-gateways-removal %} - ## Networking considerations {% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." @@ -158,7 +156,7 @@ Follow one of the procedures below to enable {% data variables.product.prodname_ {%- ifversion actions-ghes-gcp-storage %} * [Enabling GitHub Actions with Google Cloud Storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage) {%- endif %} -* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage) +* [Enabling GitHub Actions with MinIO storage](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage) ## Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise diff --git a/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 788f4b47bd1d..ceebd276ec9b 100644 --- a/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -1,7 +1,7 @@ --- -title: 使用 Azure AD 为企业配置身份验证和预配 +title: Configuring authentication and provisioning for your enterprise using Azure AD shortTitle: Configure with Azure AD -intro: '可以使用 Azure Active Directory (Azure AD) 中的租户作为标识提供者 (IdP) 来集中管理{% data variables.location.product_location %}的身份验证和用户预配。' +intro: 'You can use a tenant in Azure Active Directory (Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.location.product_location %}.' permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.' versions: ghae: '*' @@ -17,67 +17,65 @@ redirect_from: - /admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad - /admin/identity-and-access-management/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad -ms.openlocfilehash: 10b6fdaa2014836e7a709bc94920dea6331ed030 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 -ms.translationtype: HT -ms.contentlocale: zh-CN -ms.lasthandoff: 10/25/2022 -ms.locfileid: '148107507' --- -## 关于使用 Azure AD 进行身份验证和用户预配 -Azure Active Directory (Azure AD) 是一项来自 Microsoft 的服务，它允许您集中管理用户帐户和 web 应用程序访问。 有关详细信息，请参阅 Microsoft Docs 中的[什么是 Azure Active Directory？](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) +## About authentication and user provisioning with Azure AD -要管理身份以及对 {% data variables.product.product_name %} 的访问，您可以使用 Azure AD 租户作为 SAML IdP 进行身份验证。 也可以配置 Azure AD 以自动预配帐户并获取 SCIM 成员资格，这样你可以创建 {% data variables.product.product_name %} 用户，并从你的 Azure AD 租户管理团队和组织成员资格。 +Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs. + +To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access membership with SCIM, which allows you to create {% data variables.product.product_name %} users and manage team and organization membership from your Azure AD tenant. {% data reusables.scim.ghes-beta-note %} -使用 Azure AD 对 {% data variables.product.product_name %} 启用 SAML SSO 和 SCIM 后，你可以从 Azure AD 租户完成以下任务。 +After you enable SAML SSO and SCIM for {% data variables.product.product_name %} using Azure AD, you can accomplish the following from your Azure AD tenant. -* 将 Azure AD 上的 {% data variables.product.product_name %} 应用程序分配给用户帐户，以便在 {% data variables.product.product_name %} 上自动创建并授予对相应用户帐户的访问权限。 -* 为 Azure AD 上的用户帐户取消分配 {% data variables.product.product_name %} 应用程序，以便在 {% data variables.product.product_name %} 上停用相应的用户帐户。 -* 为 Azure AD 上的 IdP 组分配 {% data variables.product.product_name %} 应用程序，以便为 IdP 组的所有成员自动创建并授予对 {% data variables.product.product_name %} 上用户帐户的访问权限。 此外，IdP 组也可以在 {% data variables.product.product_name %} 上连接到团队及其父组织。 -* 从 IdP 组取消分配 {% data variables.product.product_name %} 应用程序来停用仅通过该 IdP 组访问的所有 IdP 用户的 {% data variables.product.product_name %} 用户帐户，并从父组织中删除这些用户。 IdP 组将与 {% data variables.product.product_name %} 上的任何团队断开连接。 +* Assign the {% data variables.product.product_name %} application on Azure AD to a user account to automatically create and grant access to a corresponding user account on {% data variables.product.product_name %}. +* Unassign the {% data variables.product.product_name %} application to a user account on Azure AD to deactivate the corresponding user account on {% data variables.product.product_name %}. +* Assign the {% data variables.product.product_name %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.product_name %} for connection to a team and its parent organization. +* Unassign the {% data variables.product.product_name %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. -有关在{% data variables.location.product_location %}上管理企业的身份验证和访问控制的详细信息，请参阅“[管理企业的身份验证和访问控制](/admin/authentication/managing-identity-and-access-for-your-enterprise)”。 有关将团队与 IdP 组同步的详细信息，请参阅“[将团队与标识提供者组同步](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)”。 +For more information about managing identity and access for your enterprise on {% data variables.location.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." -## 先决条件 +## Prerequisites -- 要使用 Azure AD 配置 {% data variables.product.product_name %} 的身份验证和用户预配，您必须有 Azure AD 帐户和租户。 有关详细信息，请参阅 [Azure AD 网站](https://azure.microsoft.com/free/active-directory)和 Microsoft Docs 中的[快速入门：创建 Azure Active Directory 租户](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant)。 +- To configure authentication and user provisioning for {% data variables.product.product_name %} using Azure AD, you must have an Azure AD account and tenant. For more information, see the [Azure AD website](https://azure.microsoft.com/free/active-directory) and [Quickstart: Create an Azure Active Directory tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) in the Microsoft Docs. {%- ifversion scim-for-ghes %} -- {% data reusables.saml.ghes-you-must-configure-saml-sso %} {%- endif %} - -- {% data reusables.saml.assert-the-administrator-attribute %} 有关在 Azure AD 的 SAML 声明中包含 `administrator` 属性的详细信息，请参阅 Microsoft Docs 中的[如何：为企业应用程序自定义 SAML 令牌中颁发的声明](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization)。 +- {% data reusables.saml.ghes-you-must-configure-saml-sso %} +{%- endif %} - {% data reusables.saml.create-a-machine-user %} -## 使用 Azure AD 配置身份验证和用户预配 +## Configuring authentication and user provisioning with Azure AD -在 Azure AD 租户中，添加 {% data variables.product.product_name %} 的应用程序，然后配置预配。 +In your Azure AD tenant, add the application for {% data variables.product.product_name %}, then configure provisioning. {% ifversion ghae %} -1. 在 Azure AD 中，将 {% data variables.enterprise.ae_azure_ad_app_link %} 添加到租户并配置单一登录。 有关详细信息，请参阅 Microsoft Docs 中的[教程：Azure Active Directory 单一登录 (SSO) 与 {% data variables.product.product_name %} 的集成](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial)。 +1. In Azure AD, add the {% data variables.enterprise.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.product_name %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs. -1. 在 {% data variables.product.product_name %} 中，输入 Azure AD 租户的详细信息。 +1. In {% data variables.product.product_name %}, enter the details for your Azure AD tenant. - {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} - - 如果已使用其他 IdP 为{% data variables.location.product_location %}配置 SAML SSO，并且希望改为使用 Azure AD，你可以编辑配置。 有关详细信息，请参阅“[为企业配置 SAML 单一登录](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)”。 + - If you've already configured SAML SSO for {% data variables.location.product_location %} using another IdP and you want to use Azure AD instead, you can edit your configuration. For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)." -1. 在 {% data variables.product.product_name %} 中启用用户预配，并在 Azure AD 中配置用户预配。 有关详细信息，请参阅“[为企业配置用户预配](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)”。 +1. Enable user provisioning in {% data variables.product.product_name %} and configure user provisioning in Azure AD. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." {% elsif scim-for-ghes %} -1. 在 Azure AD 租户的左侧栏中，单击“预配”。 +1. In the Azure AD tenant, in the left sidebar, click **Provisioning**. -1. 在“租户 URL”下，键入 {% data variables.location.product_location %}上 SCIM 的完整终结点 URL。 有关详细信息，请参阅 REST API 文档中的“[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)”。 +1. Under "Tenant URL", type the full endpoint URL for SCIM on {% data variables.location.product_location %}. For more information, see "[SCIM](/rest/enterprise-admin/scim#scim-endpoint-urls)" in the REST API documentation. -1. 在“机密令牌”下，输入在“[使用 SCIM 为企业配置用户配置](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)”的步骤 4 中创建的{% data variables.product.pat_v1 %}。 +1. Under "Secret Token", type the {% data variables.product.pat_v1 %} that you created in step 4 of "[Configuring user provisioning with SCIM for your enterprise](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." -1. 要确保从 Azure AD 成功连接到 {% data variables.location.product_location %}，请单击“测试连接”。 +1. To ensure a successful connection from Azure AD to {% data variables.location.product_location %}, Click **Test Connection**. -1. 确保连接成功后，单击页面顶部的“保存”。 +1. After you ensure a successful connection, at the top of the page, click **Save**. {% endif %} + +1. Assign an enterprise owner for {% data variables.product.product_name %} in Azure AD. The process you should follow depends on whether you configured provisioning. For more information about enterprise owners, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." + - If you configured provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, assign the enterprise owner role to the user in Azure AD. + - If you did not configure provisioning, to grant the user enterprise ownership in {% data variables.product.product_name %}, include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs. diff --git a/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index 443b6038e140..935cf07d9036 100644 --- a/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -24,19 +24,10 @@ This quickstart shows you how to set up MinIO using Docker for use with {% data | MinIO mode | Optimized for | Storage infrastructure required | |----|----|----| | Standalone MinIO (on a single host) | Fast setup | N/A | -| MinIO as a NAS gateway | NAS (Network-attached storage)| NAS devices | | Clustered MinIO (also called Distributed MinIO)| Data security | Storage servers running in a cluster | For more information about your options, see the official [MinIO docs](https://docs.min.io/). -{% warning %} - -**Warning**: MinIO has announced removal of MinIO Gateways. Starting June 1st, 2022, support and bug fixes for the current MinIO NAS Gateway implementation will only be available for paid customers via their LTS support contract. If you want to continue using MinIO Gateways with {% data variables.product.prodname_registry %}, we recommend moving to MinIO LTS support. For more information, see [Scheduled removal of MinIO Gateway for GCS, Azure, HDFS](https://github.com/minio/minio/issues/14331) in the minio/minio repository. - -Other modes of MinIO remain available with standard support. - -{% endwarning %} - ## 2. Install, run, and sign in to MinIO 1. Set up your preferred environment variables for MinIO. @@ -93,18 +84,6 @@ Other modes of MinIO remain available with standard support. For more information, see "[MinIO Docker Quickstart guide](https://docs.min.io/docs/minio-docker-quickstart-guide.html)." - * Run MinIO using Docker as a NAS gateway: - - This setup is useful for deployments where there is already a NAS you want to use as the backup storage for {% data variables.product.prodname_registry %}. - - ```shell - $ docker run -p 9000:9000 \ - -v $MINIO_DIR:/data \ - -e "MINIO_ACCESS_KEY=$MINIO_ACCESS_KEY" \ - -e "MINIO_SECRET_KEY=$MINIO_SECRET_KEY" \ - minio/minio gateway nas /data - ``` - * Run MinIO using Docker as a cluster. This MinIO deployment uses several hosts and MinIO's erasure coding for the strongest data protection. To run MinIO in a cluster mode, see the "[Distributed MinIO Quickstart Guide](https://docs.min.io/docs/distributed-minio-quickstart-guide.html)." ## 3. Create your MinIO bucket for {% data variables.product.prodname_registry %} @@ -124,7 +103,7 @@ Other modes of MinIO remain available with standard support. $ docker run minio/mc BUCKET-NAME ``` - This example can be used for MinIO standalone or MinIO as a NAS gateway. + This example can be used for MinIO standalone. * Clustered deployments example: diff --git a/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md b/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md index b55f575e3a6a..cf62edb6c3eb 100644 --- a/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md +++ b/translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md @@ -1,6 +1,6 @@ --- -title: 查看和管理活动的 SAML 会话 -intro: 您可以在安全设置中查看和撤销活动的 SAML 会话。 +title: Viewing and managing your active SAML sessions +intro: You can view and revoke your active SAML sessions in your settings. redirect_from: - /articles/viewing-and-managing-your-active-saml-sessions - /github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions @@ -9,28 +9,31 @@ versions: ghec: '*' topics: - SSO +type: how_to shortTitle: Active SAML sessions -ms.openlocfilehash: ee30f76143ec28a810cd23150d115a3b1cd213c8 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: zh-CN -ms.lasthandoff: 09/11/2022 -ms.locfileid: '145099900' --- -{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security %} -3. 在“Sessions（会话）”下，您可以看到活动的 SAML 会话。 - ![活动 SAML 会话列表](/assets/images/help/settings/saml-active-sessions.png) -4. 若要查看会话详细信息，请单击“查看更多”。 - ![用于打开 SAML 会话详细信息的按钮](/assets/images/help/settings/saml-expand-session-details.png) -5. 若要撤销会话，请单击“撤销 SAML”。 - ![撤销 SAML 会话的按钮](/assets/images/help/settings/saml-revoke-session.png) + +You can view a list of devices that have logged into your account, and revoke any SAML sessions that you don't recognize. + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.sessions %} +1. Under "Web sessions," you can see your active SAML sessions. + + ![Screenshot of the list of active SAML sessions](/assets/images/help/settings/saml-active-sessions.png) + +1. To see the session details, click **See more**. + ![Screenshot of the active SAML sessions with the button to open SAML session details emphasized](/assets/images/help/settings/saml-expand-session-details.png) + +1. To revoke a session, click **Revoke SAML**. + + ![Screenshot of the Session details page with the button to revoke a SAML session emphasized](/assets/images/help/settings/saml-revoke-session.png) {% note %} - **注意：** 撤销会话时，将删除对该组织的 SAML 身份验证。 要再次访问该组织，您需要通过身份提供程序单点登录。 有关详细信息，请参阅“[关于通过 SAML SSO 进行身份验证](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)”。 + **Note:** When you revoke a session, you remove your SAML authentication to that organization. To access the organization again, you will need to single sign-on through your identity provider. For more information, see "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)." {% endnote %} -## 延伸阅读 +## Further reading -- “[关于使用 SAML SSO 进行身份验证](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)” +- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" diff --git a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/index.md b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/index.md index 3e202cd3272d..b2431aab3349 100644 --- a/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/index.md +++ b/translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/index.md @@ -32,6 +32,7 @@ children: - /githubs-ssh-key-fingerprints - /sudo-mode - /preventing-unauthorized-access + - /viewing-and-managing-your-sessions shortTitle: Account security --- diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index 12e391f7d357..6fb61f5e7397 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -1,7 +1,7 @@ --- -title: Running CodeQL code scanning in a container +title: 在容器中运行 CodeQL 代码扫描 shortTitle: '{% data variables.product.prodname_code_scanning_capc %} in a container' -intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.' +intro: '通过确保所有进程都在同一容器中运行，您可以在容器中运行 {% data variables.product.prodname_code_scanning %}。' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container @@ -21,42 +21,44 @@ topics: - Repositories - Containers - Java +ms.openlocfilehash: 60dac8a7f71af067c5cfaba5f48d123a3068f704 +ms.sourcegitcommit: aa488e9e641139f9056885b1479c8801e9906131 +ms.translationtype: HT +ms.contentlocale: zh-CN +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148162805' --- - - {% data reusables.code-scanning.beta %} -## About {% data variables.product.prodname_code_scanning %} with a containerized build +## 关于使用容器化构建的 {% data variables.product.prodname_code_scanning %} -If you're setting up {% data variables.product.prodname_code_scanning %} for a compiled language, and you're building the code in a containerized environment, the analysis may fail with the error message "No source code was seen during the build." This indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code as it was compiled. +如果为编译语言设置 {% data variables.product.prodname_code_scanning %}，并且在容器化环境中构建代码，则分析可能会失败，并返回错误消息“No source code was seen during the build（在构建过程中没有看到源代码）”。 这表明 {% data variables.product.prodname_codeql %} 在代码编译过程中无法监视代码。 -You must run {% data variables.product.prodname_codeql %} inside the container in which you build your code. This applies whether you are using the {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, the {% data variables.code-scanning.codeql_runner %},{% endif %} or {% data variables.product.prodname_actions %}. For the {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}or the {% data variables.code-scanning.codeql_runner %}{% endif %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} or "[Running {% data variables.code-scanning.codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} for more information. If you're using {% data variables.product.prodname_actions %}, configure your workflow to run all the actions in the same container. For more information, see "[Example workflow](#example-workflow)." +您必须在构建代码的容器中运行 {% data variables.product.prodname_codeql %}。 无论你使用的是 {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}、{% data variables.code-scanning.codeql_runner %},{% endif %} 还是 {% data variables.product.prodname_actions %}，这都适用。 有关 {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}或 {% data variables.code-scanning.codeql_runner %}{% endif %}，请参阅“[在 CI 系统中安装 {% data variables.product.prodname_codeql_cli %}](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)”{% ifversion codeql-runner-supported %} 或“[在 CI 系统中运行 {% data variables.code-scanning.codeql_runner %}](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)”{% endif %}了解详细信息。 如果您使用 {% data variables.product.prodname_actions %}，请配置工作流程以在同一容器中运行所有操作。 有关详细信息，请参阅“[示例工作流](#example-workflow)”。 {% note %} -**Note:** {% data reusables.code-scanning.non-glibc-linux-support %} +注意：{% data reusables.code-scanning.non-glibc-linux-support %} {% endnote %} -## Dependencies +## 依赖项 -You may have difficulty running {% data variables.product.prodname_code_scanning %} if the container you're using is missing certain dependencies (for example, Git must be installed and added to the PATH variable). If you encounter dependency issues, review the list of software typically included on {% data variables.product.prodname_dotcom %}'s runner images. For more information, see the version-specific `readme` files in these locations: +如果您使用的容器缺少某些依赖项（例如，Git 必须安装并添加到 PATH 变量），您可能难以运行 {% data variables.product.prodname_code_scanning %}。 如果遇到依赖项问题，请查看通常包含在 {% data variables.product.prodname_dotcom %} 运行器映像中的软件列表。 有关详细信息，请参阅以下位置中特定于版本的 `readme` 文件： -* Linux: https://github.com/actions/runner-images/tree/main/images/linux -* macOS: https://github.com/actions/runner-images/tree/main/images/macos -* Windows: https://github.com/actions/runner-images/tree/main/images/win +* Linux：https://github.com/actions/runner-images/tree/main/images/linux +* macOS：https://github.com/actions/runner-images/tree/main/images/macos +* Windows： https://github.com/actions/runner-images/tree/main/images/win -## Example workflow +## 示例工作流 -{% ifversion ghes or ghae %} -{% note %} +{% ifversion ghes or ghae %} {% note %} -**Note:** This article describes the features available with the version of the CodeQL action and associated CodeQL CLI bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the CodeQL action, see the [{% data variables.product.prodname_ghe_cloud %} article](/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container) for information on the latest features.{% ifversion not ghae %} For information on using the latest version, see "[Configuring code scanning for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)."{% endif %} +注意：本文介绍了此版 {% data variables.product.product_name %} 的初始发行版中包含的 CodeQL 操作版本和相关 CodeQL CLI 捆绑包中可用的功能。 如果企业使用较新版本的 CodeQL 操作，请参阅 [{% data variables.product.prodname_ghe_cloud %} 一文](/enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container)来了解最新功能。{% ifversion not ghae %}若要了解如何使用最新版本，请参阅“[为设备配置代码扫描](/admin/advanced-security/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)”。{% endif %} -{% endnote %} -{% endif %} +{% endnote %} {% endif %} -This sample workflow uses {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_codeql %} analysis in a containerized environment. The value of `container.image` identifies the container to use. In this example the image is named `codeql-container`, with a tag of `f0f91db`. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)." +此示例工作流程在容器化环境中使用 {% data variables.product.prodname_actions %} 运行 {% data variables.product.prodname_codeql %} 分析。 `container.image` 的值标识要使用的容器。 在此示例中，映像名为 `codeql-container`，标记为 `f0f91db`。 有关详细信息，请参阅 [{% data variables.product.prodname_actions %} 的工作流语法](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)。 ``` yaml name: "{% data variables.product.prodname_codeql %}" diff --git a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md index a2d8162af9ea..46d66da9c069 100644 --- a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md +++ b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md @@ -1,7 +1,7 @@ --- -title: Migrating from the CodeQL runner to CodeQL CLI +title: 从 CodeQL 运行器迁移到 CodeQL CLI shortTitle: Migrating from the CodeQL runner -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to complete the same tasks as with the {% data variables.code-scanning.codeql_runner %}.' +intro: '可以使用 {% data variables.product.prodname_codeql_cli %} 完成与 {% data variables.code-scanning.codeql_runner %} 相同的任务。' product: '{% data reusables.gated-features.code-scanning %}' versions: fpt: '*' @@ -12,52 +12,57 @@ topics: - Advanced Security - Code scanning - CodeQL +ms.openlocfilehash: 10711111e3fa5c7226574ac9b70eb4bd4d5bff21 +ms.sourcegitcommit: b617c4a7a1e4bf2de3987a86e0eb217d7031490f +ms.translationtype: HT +ms.contentlocale: zh-CN +ms.lasthandoff: 11/11/2022 +ms.locfileid: '148161262' --- +# 从 {% data variables.code-scanning.codeql_runner %} 迁移到 {% data variables.product.prodname_codeql_cli %} -# Migrating from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %} +{% data variables.code-scanning.codeql_runner %} 将被弃用。 您可以改用 {% data variables.product.prodname_codeql_cli %} 版本 2.6.2 及更高版本。 +本文档介绍如何将常见工作流程从 {% data variables.code-scanning.codeql_runner %} 迁移到 {% data variables.product.prodname_codeql_cli %}。 -The {% data variables.code-scanning.codeql_runner %} is being deprecated. You can use the {% data variables.product.prodname_codeql_cli %} version 2.6.2 and greater instead. -This document describes how to migrate common workflows from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %}. +## 安装 -## Installation +从 [`github/codeql-action` 存储库](https://github.com/github/codeql-action/releases)下载 {% data variables.product.prodname_codeql %} 捆绑包。 此捆绑包中包含 {% data variables.product.prodname_codeql_cli %} 以及标准 {% data variables.product.prodname_codeql %} 查询和库。 -Download the **{% data variables.product.prodname_codeql %} bundle** from the [`github/codeql-action` repository](https://github.com/github/codeql-action/releases). This bundle contains the {% data variables.product.prodname_codeql_cli %} and the standard {% data variables.product.prodname_codeql %} queries and libraries. +有关设置 {% data variables.product.prodname_codeql_cli %} 的详细信息，请参阅“[在 CI 系统中安装 {% data variables.product.prodname_codeql_cli %}](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)”。 -For more information on setting up the {% data variables.product.prodname_codeql_cli %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)." +## 工作流程更改概述 -## Overview of workflow changes +使用 {% data variables.code-scanning.codeql_runner %} 分析代码库的典型工作流程具有以下步骤。 +- 使用 `codeql-runner- init` 开始创建 {% data variables.product.prodname_codeql %} 数据库并读取配置。 +- 对于编译的语言：设置 `init` 步骤生成的环境变量。 +- 对于编译的语言：运行自动构建或手动构建步骤。 +- 使用 `codeql-runner- analyze` 完成创建 {% data variables.product.prodname_codeql %} 数据库，运行查询以分析每个 {% data variables.product.prodname_codeql %} 数据库，将结果汇总到 SARIF 文件，并将结果上传到 {% data variables.product.prodname_dotcom %}。 -A typical workflow that uses the {% data variables.code-scanning.codeql_runner %} to analyze a codebase has the following steps. -- `codeql-runner- init` to start creating {% data variables.product.prodname_codeql %} databases and read the configuration. -- For compiled languages: set environment variables produced by the `init` step. -- For compiled languages: run autobuild or manual build steps. -- `codeql-runner- analyze` to finish creating {% data variables.product.prodname_codeql %} databases, run queries to analyze each {% data variables.product.prodname_codeql %} database, summarize the results in a SARIF file, and upload the results to {% data variables.product.prodname_dotcom %}. +使用 {% data variables.product.prodname_codeql_cli %} 分析代码库的典型工作流程具有以下步骤。 +- 使用 `codeql database create` 创建 {% data variables.product.prodname_codeql %} 数据库。 + - 对于编译的语言：（可选）提供构建命令。 +- 使用 `codeql database analyze` 运行查询以分析每个 {% data variables.product.prodname_codeql %} 数据库，并将结果汇总到 SARIF 文件中。 必须对每种语言或每个数据库运行一次此命令。 +- 使用 `codeql github upload-results` 将生成的 SARIF 文件上传到 {% data variables.product.prodname_dotcom %}，以显示为代码扫描警报。 必须对每种语言或每个 SARIF 文件运行一次此命令。 -A typical workflow that uses the {% data variables.product.prodname_codeql_cli %} to analyze a codebase has the following steps. -- `codeql database create` to create {% data variables.product.prodname_codeql %} databases. - - For compiled languages: Optionally provide a build command. -- `codeql database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. This command must be run once for each language or database. -- `codeql github upload-results` to upload the resulting SARIF files to {% data variables.product.prodname_dotcom %}, to be displayed as code scanning alerts. This command must be run once for each language or SARIF file. +默认情况下，{% data variables.code-scanning.codeql_runner %} 是多线程的。 默认情况下，{% data variables.product.prodname_codeql_cli %} 仅使用单线程，但允许您指定希望它使用的线程数。 如果要复制 {% data variables.code-scanning.codeql_runner %} 的行为，以在使用 {% data variables.product.prodname_codeql_cli %} 时使用计算机上的所有可用线程，可以将 `--threads 0` 传递给 `codeql database analyze`。 -The {% data variables.code-scanning.codeql_runner %} is multithreaded by default. The {% data variables.product.prodname_codeql_cli %} only uses a single thread by default, but allows you to specify the amount of threads you want it to use. If you want to replicate the behavior of the {% data variables.code-scanning.codeql_runner %} to use all threads available on the machine when using the {% data variables.product.prodname_codeql_cli %}, you can pass `--threads 0` to `codeql database analyze`. +有关详细信息，请参阅“[在 CI 系统中配置 {% data variables.product.prodname_codeql_cli %}](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)”。 -For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." +## {% data variables.product.prodname_codeql_cli %} 的常见使用示例 -## Examples of common uses for the {% data variables.product.prodname_codeql_cli %} +### 关于示例 -### About the examples +这些示例假定源代码已检出到当前工作目录。 如果使用其他目录，请相应地更改 `--source-root` 参数和生成步骤。 -These examples assume that the source code has been checked out to the current working directory. If you use a different directory, change the `--source-root` argument and the build steps accordingly. +这些示例还假定 {% data variables.product.prodname_codeql_cli %} 位于当前 PATH 上。 -These examples also assume that the {% data variables.product.prodname_codeql_cli %} is placed on the current PATH. +在这些示例中，具有适当范围的 {% data variables.product.prodname_dotcom %} 令牌存储在 `$TOKEN` 环境变量中，并通过 `stdin` 传递给示例命令，或者存储在 `$GITHUB_TOKEN` 环境变量中。 -In these examples, a {% data variables.product.prodname_dotcom %} token with suitable scopes is stored in the `$TOKEN` environment variable and passed to the example commands via `stdin`, or is stored in the `$GITHUB_TOKEN` environment variable. +在这些示例中检出和分析的引用名称和提交 SHA 在工作流程期间是已知的。 对于分支，请使用 `refs/heads/BRANCH-NAME` 作为引用。对于拉取请求的头提交，请使用 `refs/pull/NUMBER/head`。 对于 {% data variables.product.prodname_dotcom %} 生成的拉取请求合并提交，请使用 `refs/pull/NUMBER/merge`。 下面的示例均使用 `refs/heads/main`。 如果使用其他分支名称，则必须修改示例代码。 -The ref name and commit SHA being checked out and analyzed in these examples are known during the workflow. For a branch, use `refs/heads/BRANCH-NAME` as the ref. For the head commit of a pull request, use `refs/pull/NUMBER/head`. For a {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request, use `refs/pull/NUMBER/merge`. The examples below all use `refs/heads/main`. If you use a different branch name, you must modify the sample code. +### 单一非编译语言 (JavaScript) -### Single non-compiled language (JavaScript) - -Runner: +运行器： ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -67,7 +72,7 @@ echo "$TOKEN" | codeql-runner-linux analyze --repository my-org/example-repo --github-url https://github.com --github-auth-stdin --commit deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 --ref refs/heads/main ``` -CLI: +CLI： ```bash codeql database create /codeql-dbs/example-repo --language=javascript \ --source-root=. @@ -82,11 +87,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single non-compiled language (JavaScript) using a different query suite (security-and-quality) +### 使用不同查询套件 (security-and-quality) 的单个非编译语言 (JavaScript) -A similar approach can be taken for compiled languages, or multiple languages. +对于编译语言或多种语言，可以采用类似的方法。 -Runner: +运行器： ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -97,7 +102,7 @@ echo "$TOKEN" | codeql-runner-linux analyze --repository my-org/example-repo \ --github-url https://github.com --github-auth-stdin \ --commit deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 --ref refs/heads/main ``` -CLI: +CLI： ```bash codeql database create /codeql-dbs/example-repo --language=javascript \ --source-root=. @@ -112,11 +117,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single non-compiled language (JavaScript) using a custom configuration file +### 使用自定义配置文件的单个非编译语言 (JavaScript) -A similar approach can be taken for compiled languages, or multiple languages. +对于编译语言或多种语言，可以采用类似的方法。 -Runner: +运行器： ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages javascript \ @@ -127,7 +132,7 @@ echo "$TOKEN" | codeql-runner-linux analyze --repository my-org/example-repo \ --github-url https://github.com --github-auth-stdin \ --commit deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 --ref refs/heads/main ``` -CLI: +CLI： ```bash # Use `--codescanning-config` with the path to the YAML configuration file. codeql database create /codeql-dbs/example-repo --language=javascript \ @@ -143,9 +148,9 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-js.sarif --github-auth-stdin ``` -### Single compiled language using autobuild (Java) +### 使用自动构建的单一编译语言 (Java) -Runner: +运行器： ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages java \ @@ -161,7 +166,7 @@ echo "$TOKEN" | codeql-runner-linux analyze --repository my-org/example-repo --github-url https://github.com --github-auth-stdin --commit deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 --ref refs/heads/main ``` -CLI: +CLI： ```bash # Run `codeql database create` without `--command`. # This will run the autobuilder for the given language. @@ -177,9 +182,9 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-java.sarif --github-auth-stdin ``` -### Single compiled language using a custom build command (Java) +### 使用自定义构建命令的单一编译语言 (Java) -Runner: +运行器： ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages java \ @@ -195,7 +200,7 @@ echo "$TOKEN" | codeql-runner-linux analyze --repository my-org/example-repo --github-url https://github.com --github-auth-stdin --commit deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 --ref refs/heads/main ``` -CLI: +CLI： ```bash # Provide an explicit build command using `--command`. codeql database create /codeql-dbs/example-repo --language=java \ @@ -210,11 +215,11 @@ echo "$TOKEN" | codeql github upload-results --repository=my-org/example-repo \ --sarif=/temp/example-repo-java.sarif --github-auth-stdin ``` -### Single compiled language using indirect build tracing (C# on Windows within Azure DevOps) +### 使用间接构建跟踪的单一编译语言（Azure DevOps 中的 Windows 上的 C#） -Indirect build tracing for a compiled language enables {% data variables.product.prodname_codeql %} to detect all build steps between the `init` and `analyze` steps, when the code cannot be built using the autobuilder or an explicit build command line. This is useful when using preconfigured build steps from your CI system, such as the `VSBuild` and `MSBuild` tasks in Azure DevOps. +当无法使用自动生成器或显式生成命令行生成代码时，已编译语言的间接生成跟踪可让 {% data variables.product.prodname_codeql %} 检测 `init` 与 `analyze` 步骤之间的所有生成步骤。 在使用 CI 系统中的预配置生成步骤（例如 Azure DevOps 中的 `VSBuild` 和 `MSBuild` 任务）时，这非常有用。 -Runner: +运行器： ```yaml - task: CmdLine@1 displayName: CodeQL Initialization @@ -252,7 +257,7 @@ Runner: script: '%CodeQLRunner%\codeql-runner-win.exe analyze --repository my-org/example-repo --commit $(Build.SourceVersion) --ref $(Build.SourceBranch) --github-url https://github.com --github-auth $(Token)' ``` -CLI: +CLI： ```yaml # Run any pre-build tasks, for example, restore NuGet dependencies... @@ -332,12 +337,12 @@ CLI: ``` -### Multiple languages using autobuild (C++, Python) +### 使用自动构建的多种语言（C++、Python） -This example is not strictly possible with the {% data variables.code-scanning.codeql_runner %}. -Only one language (the compiled language with the most files) will be analyzed. +此示例在 {% data variables.code-scanning.codeql_runner %} 中并非严格可行。 +将仅分析一种语言（文件最多的编译语言）。 -Runner: +运行器： ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages cpp,python \ @@ -354,7 +359,7 @@ echo "$TOKEN" | codeql-runner-linux analyze --repository my-org/example-repo --commit deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 --ref refs/heads/main ``` -CLI: +CLI： ```bash # Create multiple databases using `--db-cluster`. # Run autobuild by omitting `--command`. @@ -375,9 +380,9 @@ for language in cpp python; do done ``` -### Multiple languages using a custom build command (C++, Python) +### 使用自定义构建命令的多种语言（C++、Python） -Runner: +运行器： ```bash echo "$TOKEN" | codeql-runner-linux init --repository my-org/example-repo \ --languages cpp,python \ @@ -394,7 +399,7 @@ echo "$TOKEN" | codeql-runner-linux analyze --repository my-org/example-repo --commit deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 --ref refs/heads/main ``` -CLI: +CLI： ```bash # Create multiple databases using `--db-cluster`. codeql database create /codeql-dbs/example-repo-multi \ diff --git a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md b/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md index 0e56df084315..692b4c28a681 100644 --- a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md +++ b/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md @@ -20,7 +20,13 @@ shortTitle: GPG verification After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_github_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." -Once you enable GPG verification, it will immediately take effect for all your codespaces. +{% data reusables.codespaces.gpg-in-active-codespaces %} + +{% note %} + +**Note:** If you have linked a dotfiles repository with {% data variables.product.prodname_github_codespaces %}, the Git configuration in your dotfiles may conflict with the configuration that {% data variables.product.prodname_github_codespaces %} requires to sign commits. For more information, see "[Troubleshooting GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces)." + +{% endnote %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} @@ -30,8 +36,4 @@ Once you enable GPG verification, it will immediately take effect for all your c !["Selected repositories" dropdown menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) -{% note %} - -**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, you also must append `-S` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings. - -{% endnote %} +Once you have enabled GPG verification for {% data variables.product.prodname_github_codespaces %}, all commits are signed by default in your codespaces. \ No newline at end of file diff --git a/translations/zh-CN/content/codespaces/troubleshooting/index.md b/translations/zh-CN/content/codespaces/troubleshooting/index.md index 2aeca351ebd3..cabc8b2247c8 100644 --- a/translations/zh-CN/content/codespaces/troubleshooting/index.md +++ b/translations/zh-CN/content/codespaces/troubleshooting/index.md @@ -19,6 +19,7 @@ children: - /troubleshooting-dotfiles-for-codespaces - /troubleshooting-port-forwarding-for-github-codespaces - /troubleshooting-github-codespaces-clients + - /troubleshooting-gpg-verification-for-github-codespaces - /working-with-support-for-github-codespaces --- diff --git a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 7f68a7bb8873..fdfc96b3885c 100644 --- a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1,6 +1,6 @@ --- title: Webhook events and payloads -intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.' +intro: 'Learn about when each webhook event occurs and what the payload contains.' product: '{% data reusables.gated-features.enterprise_account_webhooks %}' redirect_from: - /early-access/integrations/webhooks @@ -97,1568 +97,4 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. > } ``` -{% ifversion fpt or ghes > 3.3 or ghae or ghec %} -## branch_protection_rule - -Activity related to a branch protection rule. For more information, see "[About branch protection rules](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`rule` | `object` | The branch protection rule. Includes a `name` and all the [branch protection settings](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. -`changes` | `object` | If the action was `edited`, the changes to the rule. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.branch_protection_rule.edited }} -{% endif %} - -{% ifversion ghes > 3.3 %} -## cache_sync - -A Git ref has been successfully synced to a cache replica. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`cache_location` |`string` | The location of the cache server that has been updated. -`ref` | `string` | The ref that has been updated. -`before` | `string` | The OID of the ref on the cache replica before it was updated. -`after` | `string` | The OID of the ref on the cache replica after the update. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.cache_sync.synced }} -{% endif %} - -## check_run - -{% data reusables.webhooks.check_run_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `created` and `completed` event types in a repository -- Organization webhooks only receive payloads for the `created` and `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_run_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_run.created }} - -## check_suite - -{% data reusables.webhooks.check_suite_short_desc %} - -{% data reusables.apps.undetected-pushes-to-a-forked-repository-for-check-suites %} - -### Availability - -- Repository webhooks only receive payloads for the `completed` event types in a repository -- Organization webhooks only receive payloads for the `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. - -### Webhook payload object - -{% data reusables.webhooks.check_suite_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.check_suite.completed }} - -## code_scanning_alert - -{% data reusables.webhooks.code_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.code_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `reopened_by_user` or `closed_by_user`, the `sender` object will be the user that triggered the event. The `sender` object is {% ifversion fpt or ghec %}`github`{% elsif ghes or ghae %}`github-enterprise`{% else %}empty{% endif %} for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.code_scanning_alert.reopened }} - -## commit_comment - -{% data reusables.webhooks.commit_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.commit_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.commit_comment.created }} - -{% ifversion ghes < 3.4 %} -## content_reference - -{% data reusables.webhooks.content_reference_short_desc %} - -Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" to create a new content attachment. - -### Availability - -- {% data variables.product.prodname_github_apps %} with the `content_references:write` permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.content_reference.created }} - -{% endif %} -## create - -{% data reusables.webhooks.create_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you create more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.create_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.create }} - -## delete - -{% data reusables.webhooks.delete_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you delete more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.delete_properties %} -{% data reusables.webhooks.pusher_type_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.delete }} - -{% ifversion fpt or ghec %} -## dependabot_alert - -{% data reusables.webhooks.dependabot_alert_description %} - -### Availability - -{% data reusables.webhooks.dependabot_alert_availability %} - -### Webhook payload object - -{% data reusables.webhooks.dependabot_alert_payload %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.dependabot_alert.fixed }} -{% endif %} - -## deploy_key - -{% data reusables.webhooks.deploy_key_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.deploy_key_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deploy_key.created }} - -## deployment - -{% data reusables.webhooks.deployment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments). -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment }} - -## deployment_status - -{% data reusables.webhooks.deployment_status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Deployments** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`. -`deployment_status` |`object` | The [deployment status](/rest/reference/deployments#list-deployment-statuses). -`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`deployment_status["target_url"]` |`string` | The optional link added to the status. -`deployment_status["description"]`|`string` | The optional human-readable description added to the status. -`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments) that this status is associated with. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.deployment_status }} - -{% ifversion fpt or ghec %} -## discussion - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a discussion. For more information, see the "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, `deleted`, `pinned`, `unpinned`, `locked`, `unlocked`, `transferred`, `category_changed`, `answered`, `unanswered`, `labeled`, or `unlabeled`. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion.created }} - -## discussion_comment - -{% data reusables.webhooks.discussions-webhooks-beta %} - -Activity related to a comment in a discussion. For more information, see "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)." - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Discussions** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `created`, `edited`, or `deleted`. -`comment` | `object` | The [`discussion comment`](/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource. -{% data reusables.webhooks.discussion_desc %} -{% data reusables.webhooks.repo_desc_graphql %} -{% data reusables.webhooks.org_desc_graphql %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.discussion_comment.created }} -{% endif %} - -{% ifversion ghes or ghae %} - -## enterprise - -{% data reusables.webhooks.enterprise_short_desc %} - -### Availability - -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `anonymous_access_enabled` or `anonymous_access_disabled`. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.enterprise.anonymous_access_enabled }} - -{% endif %} - -## fork - -{% data reusables.webhooks.fork_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.fork_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.fork }} - -## github_app_authorization - -When someone revokes their authorization of a {% data variables.product.prodname_github_app %}, this event occurs. A {% data variables.product.prodname_github_app %} receives this webhook by default and cannot unsubscribe from this event. - -{% data reusables.webhooks.authorization_event %} For details about user-to-server requests, which require {% data variables.product.prodname_github_app %} authorization, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `revoked`. -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.github_app_authorization.revoked }} - -## gollum - -{% data reusables.webhooks.gollum_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.gollum_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.gollum }} - -## installation - -{% data reusables.webhooks.installation_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation.deleted }} - -## installation_repositories - -{% data reusables.webhooks.installation_repositories_short_desc %} - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -{% data reusables.webhooks.installation_repositories_properties %} -{% data reusables.webhooks.app_always_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.installation_repositories.added }} - -## issue_comment - -{% data reusables.webhooks.issue_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_comment_webhook_properties %} -{% data reusables.webhooks.issue_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.issue_comment.created }} - -## issues - -{% data reusables.webhooks.issues_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Issues** permission - -### Webhook payload object - -{% data reusables.webhooks.issue_webhook_properties %} -{% data reusables.webhooks.issue_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone edits an issue - -{{ webhookPayloadsForCurrentVersion.issues.edited }} - -## label - -{% data reusables.webhooks.label_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Can be `created`, `edited`, or `deleted`. -`label`|`object` | The label that was added. -`changes`|`object`| The changes to the label if the action was `edited`. -`changes[name][from]`|`string` | The previous version of the name if the action was `edited`. -`changes[color][from]`|`string` | The previous version of the color if the action was `edited`. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.label.deleted }} - -{% ifversion fpt or ghec %} -## marketplace_purchase - -Activity related to a GitHub Marketplace purchase. {% data reusables.webhooks.action_type_desc %} For more information, see the "[GitHub Marketplace](/marketplace/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` | `string` | The action performed for a [GitHub Marketplace](https://github.com/marketplace) plan. Can be one of:
  • `purchased` - Someone purchased a GitHub Marketplace plan. The change should take effect on the account immediately.
  • `pending_change` - You will receive the `pending_change` event when someone has downgraded or cancelled a GitHub Marketplace plan to indicate a change will occur on the account. The new plan or cancellation takes effect at the end of the billing cycle. The `cancelled` or `changed` event type will be sent when the billing cycle has ended and the cancellation or new plan should take effect.
  • `pending_change_cancelled` - Someone has cancelled a pending change. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.
  • `changed` - Someone has upgraded or downgraded a GitHub Marketplace plan and the change should take effect on the account immediately.
  • `cancelled` - Someone cancelled a GitHub Marketplace plan and the last billing cycle has ended. The change should take effect on the account immediately.
- -For a detailed description of this payload and the payload for each type of `action`, see [{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/). - -### Webhook payload example when someone purchases the plan - -{{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }} - -{% endif %} - -## member - -{% data reusables.webhooks.member_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.member_webhook_properties %} -{% data reusables.webhooks.member_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.member.added }} - -## membership - -{% data reusables.webhooks.membership_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -{% data reusables.webhooks.membership_properties %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.membership.removed }} - -{% ifversion fpt or ghec %} - -## merge_group - -{% data reusables.pull_requests.merge-queue-beta %} - -Activity related to merge groups in a merge queue. The type of activity is specified in the action property of the payload object. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Merge queues** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed. Currently, can only be `checks_requested`. -`merge_group`|`object` | The merge group. -`merge_group[head_sha]`|`string` | The SHA of the merge group. -`merge_group[head_ref]`|`string` | The full ref of the merge group. -`merge_group[base_sha]`|`string` | The SHA of the merge group's parent commit. -`merge_group[base_ref]`|`string` | The full ref of the branch the merge group will be merged into. -`merge_group[head_commit]`|`object` | An expanded representation of the `head_sha` commit. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.merge_group.checks_requested }} - -{% endif %} - -## meta - -The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action performed. Can be `deleted`. -`hook_id` |`integer` | The id of the modified webhook. -`hook` |`object` | The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.meta.deleted }} - -## milestone - -{% data reusables.webhooks.milestone_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.milestone_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.milestone.created }} - -## organization - -{% data reusables.webhooks.organization_short_desc %} - -### Availability - -{% ifversion ghes or ghae %} -- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} -- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of:{% ifversion ghes or ghae %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`. -`invitation` |`object` | The invitation for the user or email if the action is `member_invited`. -`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.organization.member_added }} - -{% ifversion fpt or ghec %} - -## org_block - -{% data reusables.webhooks.org_block_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`action` | `string` | The action performed. Can be `blocked` or `unblocked`. -`blocked_user` | `object` | Information about the user that was blocked or unblocked. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.org_block.blocked }} - -{% endif %} - -## package - -Activity related to {% data variables.product.prodname_registry %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[Managing packages with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages)" to learn more about {% data variables.product.prodname_registry %}. - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.package_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.package.published }} - -## page_build - -{% data reusables.webhooks.page_build_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pages** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`id` | `integer` | The unique identifier of the page build. -`build` | `object` | The [List GitHub Pages builds](/rest/reference/pages#list-github-pages-builds) itself. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.page_build }} - -## ping - -{% data reusables.webhooks.ping_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} receive a ping event with an `app_id` used to register the app - -### Webhook payload object - -Key | Type | Description -----|------|------------ -`zen` | `string` | Random string of GitHub zen. -`hook_id` | `integer` | The ID of the webhook that triggered the ping. -`hook` | `object` | The [webhook configuration](/rest/reference/webhooks#get-a-repository-webhook). -`hook[app_id]` | `integer` | When you register a new {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/) an app. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.ping }} - -## project - -{% data reusables.webhooks.project_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project.created }} - -## project_card - -{% data reusables.webhooks.project_card_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_card_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_card.created }} - -## project_column - -{% data reusables.webhooks.project_column_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission - -{% ifversion projects-v2 %} -{% note %} - -**Note**: This event only occurs for {% data variables.product.prodname_projects_v1 %}. - -{% endnote %} -{% endif %} - -### Webhook payload object - -{% data reusables.webhooks.project_column_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.project_column.created }} - -{% ifversion project-beta-webhooks %} - -## projects_v2_item - -{% note %} - -**Note:** Webhook events for {% data variables.projects.projects_v2 %} are currently in beta and subject to change. To share feedback about {% data variables.projects.projects_v2 %} webhooks with {% data variables.product.product_name %}, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - -{% endnote %} - -Activity related to items in a {% data variables.projects.project_v2 %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[About {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Projects** organization permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action`|`string` | The action that was performed on the project item. Can be one of `archived`, `converted`, `created`, `edited`, `restored`, `deleted`, or `reordered`. -`projects_v2_item`|`object` | The project item itself. To find more information about the project item, you can use `node_id` (the node ID of the project item) and `project_node_id` (the node ID of the project) to query information in the GraphQL API. For more information, see "[Using the API to manage projects](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." -`changes`|`object` | The changes to the project item. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.projects_v2_item.created }} - -{% endif %} - -## public - -{% data reusables.webhooks.public_short_desc %} -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.public }} - -## pull_request - -{% data reusables.webhooks.pull_request_short_desc %} - -{% ifversion fpt or ghec %} - {% data reusables.pull_requests.merge-queue-beta %} -{% endif %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_webhook_properties %} -{% data reusables.webhooks.pull_request_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -Deliveries for `review_requested` and `review_request_removed` events will have an additional field called `requested_reviewer`. - -{{ webhookPayloadsForCurrentVersion.pull_request.opened }} - -## pull_request_review - -{% data reusables.webhooks.pull_request_review_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review.submitted }} - -## pull_request_review_comment - -{% data reusables.webhooks.pull_request_review_comment_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_review_comment_webhook_properties %} -{% data reusables.webhooks.pull_request_review_comment_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} - -## pull_request_review_thread - -{% data reusables.webhooks.pull_request_review_thread_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Pull requests** permission - -### Webhook payload object - -{% data reusables.webhooks.pull_request_thread_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }} - -## push - -{% data reusables.webhooks.push_short_desc %} - -{% note %} - -**Note:** You will not receive a webhook for this event when you push more than three tags at once. - -{% endnote %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`ref`|`string` | The full [`git ref`](/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. -`before`|`string` | The SHA of the most recent commit on `ref` before the push. -`after`|`string` | The SHA of the most recent commit on `ref` after the push. -`created`|`boolean` | Whether this push created the `ref`. -`deleted`|`boolean` | Whether this push deleted the `ref`. -`forced`|`boolean` | Whether this push was a force push of the `ref`. -`head_commit`|`object` | For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag. -`compare`|`string` | 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. -`commits`|`array` | 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.) -`commits[][id]`|`string` | The SHA of the commit. -`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit. -`commits[][message]`|`string` | The commit message. -`commits[][author]`|`object` | The git author of the commit. -`commits[][author][name]`|`string` | The git author's name. -`commits[][author][email]`|`string` | The git author's email address. -`commits[][url]`|`url` | URL that points to the commit API resource. -`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before. -`commits[][added]`|`array` | An array of files added in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were added. -`commits[][modified]`|`array` | An array of files modified by the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were modified. -`commits[][removed]`|`array` | An array of files removed in the commit. For extremely large commits where {% data variables.product.product_name %} is unable to calculate this list in a timely manner, this may be empty even if files were removed. -`pusher` | `object` | The user who pushed the commits. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.push }} - -## release - -{% data reusables.webhooks.release_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -{% data reusables.webhooks.release_webhook_properties %} -{% data reusables.webhooks.release_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.release.published }} - -## repository_dispatch - -This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)" endpoint. - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_dispatch }} - -## repository - -{% data reusables.webhooks.repository_short_desc %} - -### Availability - -- Repository webhooks receive all event types except `deleted` -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted` - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. This can be one of:
  • `created` - A repository is created.
  • `deleted` - A repository is deleted.
  • `archived` - A repository is archived.
  • `unarchived` - A repository is unarchived.
    • {% ifversion ghes or ghae %}
  • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
    • {% endif %}
  • `edited` - A repository's information is edited.
  • `renamed` - A repository is renamed.
  • `transferred` - A repository is transferred.
  • `publicized` - A repository is made public.
  • `privatized` - A repository is made private.
-{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository.publicized }} - -{% ifversion fpt or ghec %} -## repository_import - -{% data reusables.webhooks.repository_import_short_desc %} To receive this event for a personal repository, you must create an empty repository prior to the import. This event can be triggered using either the [GitHub Importer](/articles/importing-a-repository-with-github-importer/) or the [Source imports API](/rest/reference/migrations#source-imports). - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_import_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_import }} - -## repository_vulnerability_alert - -{% data reusables.webhooks.repository_vulnerability_alert_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.repository_vulnerability_alert_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.repository_vulnerability_alert.create }} - -{% endif %} - -{% ifversion ghes or ghec %} - -## secret_scanning_alert - -{% data reusables.webhooks.secret_scanning_alert_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -`sender` | `object` | If the `action` is `resolved` or `reopened`, the `sender` object will be the user that triggered the event. The `sender` object is empty for all other actions. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} -{% endif %} - -{% ifversion ghes > 3.4 or ghec or ghae > 3.4 %} -## secret_scanning_alert_location - -{% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission - -### Webhook payload object - -{% data reusables.webhooks.secret_scanning_alert_location_event_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.secret_scanning_alert_location.created }} -{% endif %} - -{% ifversion fpt or ghes or ghec %} -## security_advisory - -Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}. - -The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." - -### Availability - -- {% data variables.product.prodname_github_apps %} - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. The action can be one of `published`, `updated`, `performed`, or `withdrawn` for all new events. -`security_advisory` |`object` | The details of the security advisory, including summary, description, and severity. - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_advisory.published }} - -{% endif %} - -{% ifversion ghas-enablement-webhook %} - -## security_and_analysis - -Activity related to enabling or disabling code security and analysis features for a repository or organization. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Administration** repository permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`changes`|`object` | The changes that were made to the code security and analysis features. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.security_and_analysis }} - -{% endif %} - -{% ifversion fpt or ghec %} -## sponsorship - -{% data reusables.webhooks.sponsorship_short_desc %} - -You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". - -### Availability - -- Sponsored accounts - -### Webhook payload object - -{% data reusables.webhooks.sponsorship_webhook_properties %} -{% data reusables.webhooks.sponsorship_properties %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example when someone creates a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.created }} - -### Webhook payload example when someone downgrades a sponsorship - -{{ webhookPayloadsForCurrentVersion.sponsorship.downgraded }} - -{% endif %} - -## star - -{% data reusables.webhooks.star_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks - -### Webhook payload object - -{% data reusables.webhooks.star_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.star.created }} - -## status - -{% data reusables.webhooks.status_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`id` | `integer` | The unique identifier of the status. -`sha`|`string` | The Commit SHA. -`state`|`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. -`description`|`string` | The optional human-readable description added to the status. -`target_url`|`string` | The optional link added to the status. -`branches`|`array` | An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.status }} - -## team - -{% data reusables.webhooks.team_short_desc %} - -### Availability - -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`action` |`string` | The action that was performed. Can be one of `created`, `deleted`, `edited`, `added_to_repository`, or `removed_from_repository`. -`team` |`object` | The team itself. -`changes`|`object` | The changes to the team if the action was `edited`. -`changes[description][from]` |`string` | The previous version of the description if the action was `edited`. -`changes[name][from]` |`string` | The previous version of the name if the action was `edited`. -`changes[privacy][from]` |`string` | The previous version of the team's privacy if the action was `edited`. -`changes[repository][permissions][from][admin]` | `boolean` | The previous version of the team member's `admin` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][pull]` | `boolean` | The previous version of the team member's `pull` permission on a repository, if the action was `edited`. -`changes[repository][permissions][from][push]` | `boolean` | The previous version of the team member's `push` permission on a repository, if the action was `edited`. -`repository`|`object` | The repository that was added or removed from to the team's purview if the action was `added_to_repository`, `removed_from_repository`, or `edited`. For `edited` actions, `repository` also contains the team's new permission levels for the repository. -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team.added_to_repository }} - -## team_add - -{% data reusables.webhooks.team_add_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Members** permission - -### Webhook payload object - -Key | Type | Description -----|------|------------- -`team`|`object` | The [team](/rest/reference/teams) that was modified. **Note:** Older events may not include this in the payload. -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.team_add }} - -{% ifversion ghes or ghae %} - -## user - -When a user is `created` or `deleted`. - -### Availability -- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)." - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.user.created }} - -{% endif %} - -## watch - -{% data reusables.webhooks.watch_short_desc %} - -The event’s actor is the [user](/rest/reference/users) who starred a repository, and the event’s repository is the [repository](/rest/reference/repos) that was starred. - -### Availability - -- Repository webhooks -- Organization webhooks -- {% data variables.product.prodname_github_apps %} with **Metadata** permission - -### Webhook payload object - -{% data reusables.webhooks.watch_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.app_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.watch.started }} - -{% ifversion fpt or ghes or ghec %} -## workflow_dispatch - -This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the "[Create a workflow dispatch event](/rest/reference/actions/#create-a-workflow-dispatch-event)" endpoint. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Contents** permission - -### Webhook payload object - -| Key | Type | Description | -|-----|-----|-----| -| `inputs` | `object` | Inputs to the workflow. Each key represents the name of the input while its value represents the value of that input. | -{% data reusables.webhooks.org_desc %} -| `ref` | `string` | The branch or tag from which the workflow was run. | -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} -| `workflow` | `string` | Relative path to the workflow file which contains the workflow. | - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_dispatch }} -{% endif %} - -## workflow_job - -{% data reusables.webhooks.workflow_job_short_desc %} - -### Availability - -- Repository webhooks -- Organization webhooks -- Enterprise webhooks - -### Webhook payload object - -{% data reusables.webhooks.workflow_job_properties %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_job }} - -{% ifversion fpt or ghes or ghec %} -## workflow_run - -When a {% data variables.product.prodname_actions %} workflow run is requested or completed. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_run)." - -### Availability - -- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions - -### Webhook payload object - -{% data reusables.webhooks.workflow_run_properties %} -{% data reusables.webhooks.workflow_desc %} -{% data reusables.webhooks.org_desc %} -{% data reusables.webhooks.repo_desc %} -{% data reusables.webhooks.sender_desc %} - -### Webhook payload example - -{{ webhookPayloadsForCurrentVersion.workflow_run }} -{% endif %} + diff --git a/translations/zh-CN/content/get-started/index.md b/translations/zh-CN/content/get-started/index.md index 2c1d0e7ab76a..31665b53c779 100644 --- a/translations/zh-CN/content/get-started/index.md +++ b/translations/zh-CN/content/get-started/index.md @@ -62,11 +62,11 @@ children: - /using-git - /customizing-your-github-workflow - /privacy-on-github -ms.openlocfilehash: 4178e22c506d32b0736305936b56c4c1ff348357 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 7671e605fa3644c4690de6ed16bd9a255bb6b1f6 +ms.sourcegitcommit: 2ecb6ba7d01b2bc9a44ad74a5953b98413216051 ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147580693' +ms.lasthandoff: 11/15/2022 +ms.locfileid: '148165351' --- diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md index 916b170480e4..62e9a6540565 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: 管理组织中成员名称的显示 -intro: 您可以允许组织成员在组织的私有仓库中查看评论作者的个人资料名称。 +title: Managing the display of member names in your organization +intro: You can allow members of your organization to see a comment author's profile name in private repositories in the organization. product: '{% data reusables.gated-features.display-names %}' redirect_from: - /articles/managing-the-display-of-member-names-in-your-organization @@ -14,22 +14,20 @@ topics: - Organizations - Teams shortTitle: Manage display of member names -ms.openlocfilehash: 0a394b40689d95ea37906fef2ddc9b203e2041c3 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: zh-CN -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147409425' --- -组织所有者可管理组织中成员名称的显示。 -![评论中显示的评论者个人资料名称](/assets/images/help/issues/commenter-full-name.png) +Organization owners can manage the display of member names in an organization. -每个组织成员在自己的设置中选择自己的个人资料名称。 有关详细信息，请参阅“[个性化配置文件](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#changing-your-profile-name)”。 +![Commenter's profile name displayed in comment](/assets/images/help/issues/commenter-full-name.png) -{% ifversion profile-name-enterprise-setting %} 如果企业所有者设置了企业级策略，你可能无法为组织配置此设置。 有关详细信息，请参阅“[在企业中实施存储库管理策略](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)”。{% endif %} +Changes to the display of usernames within an organization will affect the display of other people's usernames, not your own. Each organization member chooses their own profile name in their settings. For more information, see "[Personalizing your profile](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#changing-your-profile-name)." -{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. 在“管理存储库权限”下，选择或取消选择“允许成员在专用存储库中查看评论作者的个人资料名称”。 -![允许成员在专用存储库中查看评论作者全名的复选框](/assets/images/help/organizations/allow-members-to-view-full-names.png) -6. 单击“保存” 。 +{% ifversion profile-name-enterprise-setting %} +You may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."{% endif %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.member-privileges %} +5. Under "Admin repository permissions", select or unselect **Allow members to see comment author's profile name in private repositories**. +![Checkbox to allow members to see comment author's full name in private repositories](/assets/images/help/organizations/allow-members-to-view-full-names.png) +6. Click **Save**. diff --git a/translations/zh-CN/content/rest/codespaces/repository-secrets.md b/translations/zh-CN/content/rest/codespaces/repository-secrets.md index b01b430e9f7c..f01c7b12a5bd 100644 --- a/translations/zh-CN/content/rest/codespaces/repository-secrets.md +++ b/translations/zh-CN/content/rest/codespaces/repository-secrets.md @@ -3,18 +3,19 @@ title: Codespaces 存储库机密 allowTitleToDifferFromFilename: true shortTitle: Repository secrets intro: Codespaces 存储库机密 API 允许用户创建、列出和删除用户可在 codespace 中访问的存储库的机密（如云服务的访问令牌）。 +permissions: 'Users with write access to a repository can manage {% data variables.product.prodname_codespaces %} repository secrets.' versions: fpt: '*' ghec: '*' topics: - API miniTocMaxHeadingLevel: 3 -ms.openlocfilehash: d80d75934cc41db2ae12db2df47a41e74627dfef -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 95b3dfaafef598bf05f55d697716eb1036093697 +ms.sourcegitcommit: 9490533fcb7b7d5c16f8fea082a06ee66dd5db8f ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147063976' +ms.lasthandoff: 11/16/2022 +ms.locfileid: '148165599' --- ## 关于 Codespaces 存储库机密 API diff --git a/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md b/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md index 3abb7179e7ed..3c045a98d5f3 100644 --- a/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md +++ b/translations/zh-CN/data/reusables/actions/actions-audit-events-workflow.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: 1162ab428d4c20f7f0ca4af8c1ec743b30e42852 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 4f04b4395ec12d834bc4d8f350b302c09badea6d +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 10/25/2022 -ms.locfileid: "148108117" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163177" --- | 操作 | 说明 |------------------|------------------- diff --git a/translations/zh-CN/data/reusables/actions/minio-gateways-removal.md b/translations/zh-CN/data/reusables/actions/minio-gateways-removal.md deleted file mode 100644 index 8cdb0b0ed7c1..000000000000 --- a/translations/zh-CN/data/reusables/actions/minio-gateways-removal.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -ms.openlocfilehash: b960c6a45b8d934a25c2d7d24e3961fb613ad3d4 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: zh-CN -ms.lasthandoff: 09/10/2022 -ms.locfileid: "147061544" ---- -{% warning %} - -警告：MinIO 已宣布删除 MinIO 网关。 从 2022 年 6 月 1 日起，当前 MinIO NAS 网关实施的支持和 Bug 修复将仅通过其 LTS 支持合同提供给付费客户。 如果要继续使用 MinIO 网关与 {% data variables.product.prodname_actions %}，我们建议转向 MinIO LTS 支持。 有关详细信息，请参阅[计划删除 minio/minio 存储库中的适用于 GCS、Azure 和 HDFS 的 MinIO 网格](https://github.com/minio/minio/issues/14331)。 - -{% endwarning %} diff --git a/translations/zh-CN/data/reusables/audit_log/audit-log-events-workflows.md b/translations/zh-CN/data/reusables/audit_log/audit-log-events-workflows.md index cc1730adedc8..01f3aa3a05d0 100644 --- a/translations/zh-CN/data/reusables/audit_log/audit-log-events-workflows.md +++ b/translations/zh-CN/data/reusables/audit_log/audit-log-events-workflows.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: 596395b05b2e34b9793107674c8e14bf12d103c8 -ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110 +ms.openlocfilehash: 830540b45884edcec609f94aeeaaf5b661a95a51 +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 10/25/2022 -ms.locfileid: "148108048" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163209" --- | 操作 | 说明 |--------|------------ diff --git a/translations/zh-CN/data/reusables/dependabot/dependabot-tos.md b/translations/zh-CN/data/reusables/dependabot/dependabot-tos.md index 92823743b38d..27ccc7dabddf 100644 --- a/translations/zh-CN/data/reusables/dependabot/dependabot-tos.md +++ b/translations/zh-CN/data/reusables/dependabot/dependabot-tos.md @@ -1,11 +1,11 @@ --- -ms.openlocfilehash: 30fe5aa7bd3853049757fded26fb3a257f2cd491 -ms.sourcegitcommit: 770ed406ec075528ec9c9695aa4bfdc8c8b25fd3 +ms.openlocfilehash: e71674bb25f77d71366fdc2c3b8ed56d55c81657 +ms.sourcegitcommit: aa67bb5ad7aa6804c5def4390e30adcc7cf96ea1 ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 09/11/2022 -ms.locfileid: "147884849" +ms.lasthandoff: 11/15/2022 +ms.locfileid: "148165199" --- {% ifversion fpt %} {% data variables.product.prodname_dependabot %} 和所有相关功能受 [{% data variables.product.prodname_dotcom %} 服务条款](/free-pro-team@latest/github/site-policy/github-terms-of-service)约束。 -{% elsif ghec %} {% data variables.product.prodname_dependabot %} 和所有相关功能均受许可协议约束。 有关详细信息，请参阅“[{% data variables.product.company_short %} 企业客户条款](https://github.com/enterprise-legal)”。 +{% elsif ghec %} {% data variables.product.prodname_dependabot %} 和所有相关功能均受许可协议约束。 有关详细信息，请参阅“[{% data variables.product.company_short %} 企业客户条款](https://github.com/customer-terms)”。 {% endif %} diff --git a/translations/zh-CN/data/reusables/organizations/types-of-team-visibility.md b/translations/zh-CN/data/reusables/organizations/types-of-team-visibility.md index 722eedfc8058..f856647e9e6c 100644 --- a/translations/zh-CN/data/reusables/organizations/types-of-team-visibility.md +++ b/translations/zh-CN/data/reusables/organizations/types-of-team-visibility.md @@ -1,12 +1,14 @@ --- -ms.openlocfilehash: 4382f549f709e0ecdeb5a578cbfa8bd05bab4ce8 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d +ms.openlocfilehash: 6d6a0678050364e945321a4b9eaf8a06cb731554 +ms.sourcegitcommit: 1671bc6dbc112c6f8db987a6aa706612d464e68e ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 09/10/2022 -ms.locfileid: "145100427" +ms.lasthandoff: 11/11/2022 +ms.locfileid: "148163013" --- 团队可以是可见的或机密的： - 可被每个组织成员[查看和 @mentioned](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) 的可见团队。 - 机密团队只对团队中的人员和拥有所有者权限的人可见。 它们非常适合隐藏团队的敏感名称或成员，例如用于与外部伙伴或客户合作的名称。 机密团队不能嵌套在父团队下，也不能有子团队。 + +非组织成员的人员无法查看任何团队。 diff --git a/translations/zh-CN/data/reusables/projects/migrate-project-steps.md b/translations/zh-CN/data/reusables/projects/migrate-project-steps.md index 04b18d843bfd..02456c586173 100644 --- a/translations/zh-CN/data/reusables/projects/migrate-project-steps.md +++ b/translations/zh-CN/data/reusables/projects/migrate-project-steps.md @@ -1,10 +1,10 @@ --- -ms.openlocfilehash: ca36d1cc452ae102d0e4183b6d72ce854de57963 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 +ms.openlocfilehash: 06ccb7d54079b9cd73a4ce66b02ae3cc9a7b3cf1 +ms.sourcegitcommit: 094dff459fcbf7d0634930e02405606dfffd7f0a ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147423194" +ms.lasthandoff: 11/12/2022 +ms.locfileid: "148163227" --- 1. 在要迁移的项目旁边，单击 {% octicon "kebab-horizontal" aria-label="The menu icon" %} 以打开菜单。 1. 在菜单中，单击“迁移”。 diff --git a/translations/zh-CN/data/reusables/support/data-protection-and-privacy.md b/translations/zh-CN/data/reusables/support/data-protection-and-privacy.md index c84e8fb5485b..4c7b5f76c23a 100644 --- a/translations/zh-CN/data/reusables/support/data-protection-and-privacy.md +++ b/translations/zh-CN/data/reusables/support/data-protection-and-privacy.md @@ -1,11 +1,9 @@ --- -ms.openlocfilehash: f233439ae4430b7a7dd0fe3b2c4da87b60f2ab28 -ms.sourcegitcommit: 80842b4e4c500daa051eff0ccd7cde91c2d4bb36 +ms.openlocfilehash: c4ab6a9deea7bf6596f968de26f996392e3d689a +ms.sourcegitcommit: 2ecb6ba7d01b2bc9a44ad74a5953b98413216051 ms.translationtype: HT ms.contentlocale: zh-CN -ms.lasthandoff: 09/12/2022 -ms.locfileid: "145065724" +ms.lasthandoff: 11/15/2022 +ms.locfileid: "148165359" --- -使用 {% data variables.product.prodname_dotcom %} 的支持产品/服务时，你的协议条款、[GitHub 隐私声明](/free-pro-team@latest/github/site-policy/github-privacy-statement)和 [GitHub 数据保护协议](/free-pro-team@latest/github/site-policy/github-data-protection-agreement)适用。 协议是指你与我们达成的主要协议，即 [GitHub 公司服务条款](/free-pro-team@latest/github/site-policy/github-corporate-terms-of-service)、[GitHub 客户协议](https://github.com/enterprise-legal)或你的 [Microsoft 批量许可协议](/free-pro-team@latest/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing)。 - - +使用 {% data variables.product.prodname_dotcom %} 的支持产品/服务时，你的协议条款、[GitHub 隐私声明](/free-pro-team@latest/github/site-policy/github-privacy-statement)和 [GitHub 数据保护协议](/free-pro-team@latest/github/site-policy/github-data-protection-agreement)适用。 协议是指你与我们达成的主要协议，即 [GitHub 公司服务条款](/free-pro-team@latest/github/site-policy/github-corporate-terms-of-service)、[GitHub 客户协议](https://github.com/customer-terms)或你的 [Microsoft 批量许可协议](/free-pro-team@latest/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing)。